SystemLog.java

/*
This file is part of leafdigital leafChat.

leafChat 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 3 of the License, or
(at your option) any later version.

leafChat 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 leafChat. If not, see <http://www.gnu.org/licenses/>.

Copyright 2011 Samuel Marshall.
*/
package leafchat.core.api;


/**
 * Use to log data that may be of interest in debugging or troubleshooting.
 * You do not usually need to call these methods directly - instead, use
 * methods of {@link leafchat.core.api.PluginContext}.
 */
public interface SystemLog extends Singleton
{
  /**
   * Call to log a line of text.
   * @param o Object that is responsible for message (or null if none)
   * @param text Text itself (does not need to end in \n)
   */
	public void log(Object o,String text);

	/**
	 * Call to log a line of text and/or exception.
	 * @param o Object that is responsible for message (or null if none)
   * @param text Text itself (does not need to end in \n; null if none)
	 * @param t Exception (null if none)
	 */
	public void log(Object o, String text, Throwable t);
}