org.gjt.sp.jedit.EBMessage Maven / Gradle / Ivy
/*
* EBMessage.java - An EditBus message
* :tabSize=8:indentSize=8:noTabs=false:
* :folding=explicit:collapseFolds=1:
*
* Copyright (C) 1999, 2002 Slava Pestov
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
package org.gjt.sp.jedit;
/**
* The base class of all EditBus messages.
*
* Message classes extending this class typically add
* other data members and methods to provide subscribers with whatever is
* needed to handle the message appropriately.
*
* Message types sent by jEdit can be found in the
* {@link org.gjt.sp.jedit.msg} package.
*
* @author Slava Pestov
* @author John Gellene (API documentation)
* @version $Id: EBMessage.java 12625 2008-05-11 12:07:29Z kpouer $
*
* @since jEdit 2.2pre6
*/
public abstract class EBMessage
{
//{{{ EBMessage constructor
/**
* Creates a new message.
* @param source The message source
* @since jEdit 4.2pre1
*/
protected EBMessage(Object source)
{
this.source = source;
} //}}}
//{{{ EBMessage constructor
/**
* Creates a new message.
* @param source The message source
*/
protected EBMessage(EBComponent source)
{
this.source = source;
} //}}}
//{{{ getSource() method
/**
* Returns the sender of this message.
* @since jEdit 4.2pre1
*/
public Object getSource()
{
return source;
} //}}}
//{{{ toString() method
/**
* Returns a string representation of this message.
*/
@Override
public String toString()
{
String className = getClass().getName();
int index = className.lastIndexOf('.');
return className.substring(index + 1)
+ '[' + paramString() + ']';
} //}}}
//{{{ paramString() method
/**
* Returns a string representation of this message's parameters.
*/
public String paramString()
{
return "source=" + source;
} //}}}
//{{{ Private members
private Object source;
//}}}
}