org.eclipse.egit.ui/src/org/eclipse/egit/ui/ICommitMessageProvider2.java

   1 /*******************************************************************************
   2  * Copyright (C) 2017, Stefan Rademacher <stefan.rademacher@tk.de>
   3  *
   4  *
   5  * All rights reserved. This program and the accompanying materials
   6  * are made available under the terms of the Eclipse Public License v1.0
   7  * which accompanies this distribution, and is available at
   8  * http://www.eclipse.org/legal/epl-v10.html
   9  *******************************************************************************/
  10 package org.eclipse.egit.ui;
  11
  12 import org.eclipse.core.resources.IResource;
  13 import org.eclipse.egit.ui.internal.dialogs.CommitDialog;
  14
  15 /**
  16  * This interface must be implemented to be a commit message provider, that does
  17  * not only provide the message itself, but also a caret position within this
  18  * message. This message will be added to the text field in the
  19  * {@link CommitDialog}. <br/>
  20  *
  21  * @see ICommitMessageProvider
  22  * @see CommitDialog
  23  */
  24 public interface ICommitMessageProvider2 extends ICommitMessageProvider {
  25
  26         /**
  27          * Unlike {@link #getMessage(IResource[])}, this method provides a way to
  28          * retrieve not only a commit message but also a caret position within the
  29          * message.
  30          *
  31          * @param resources
  32          *            the selected resources, when this method is called.
  33          *
  34          * @return an object, containing the commit message and the caret position
  35          *         within the message
  36          */
  37         CommitMessageWithCaretPosition getCommitMessageWithPosition(
  38                         IResource[] resources);
  39
  40 }