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

   1 /*******************************************************************************
   2  * Copyright (C) 2010, Thorsten Kamann <thorsten@kamann.info>
   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. A commit
  17  * message provider provides the complete or a fragment of a commit message.
  18  * This message will be added to the text field in the {@link CommitDialog}. <br/>
  19  *
  20  * @see CommitDialog
  21  */
  22 public interface ICommitMessageProvider {
  23
  24         /**
  25          * @param resources
  26          * @return the message the CommitDialog should use as default message or
  27          * <code>null</code> if this provider cannot provide a commit message
  28          */
  29         public String getMessage(IResource[] resources);
  30 }