View Javadoc

1   /*
2   Karma core - Core of the Karma application
3   Copyright (C) 2004  Toolforge <www.toolforge.nl>
4   
5   This library is free software; you can redistribute it and/or
6   modify it under the terms of the GNU Lesser General Public
7   License as published by the Free Software Foundation; either
8   version 2.1 of the License, or (at your option) any later version.
9   
10  This library is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  Lesser General Public License for more details.
14  
15  You should have received a copy of the GNU Lesser General Public
16  License along with this library; if not, write to the Free Software
17  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  */
19  package nl.toolforge.karma.core.cmd.event;
20  
21  /***
22   * <p>A command message is a message container for messages generated by <code>Command</code>s. A general message from a
23   * <code>CVS</code>-command could be an <code>OK</code> from the server. Another example is a message containing a
24   * formatted string.
25   *
26   * @author D.A. Smedes
27   * @version $Id: Message.java,v 1.1 2004/10/09 21:24:24 asmedes Exp $
28   */
29  public interface Message {
30  
31  	/***
32  	 * Returns the message in a human readable form. This string should be formatted without
33  	 * newline characters, to enable any interface application to process them easily.
34  	 *
35  	 * @return The message text of this message.
36  	 */
37  	public String getMessageText();
38  }