BasicFormatter.java

/*
 * Lilith - a log event viewer.
 * Copyright (C) 2007-2014 Joern Huxhorn
 *
 * 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 3 of the License, or
 * (at your option) 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, see <http://www.gnu.org/licenses/>.
 */
package de.huxhorn.lilith.services;

public interface BasicFormatter
{
	/**
	 * Returns true, if this formatter is able to format the given object into a String.
	 *
	 * @param object the input to both isCompatible(...) and toString(...).
	 * @return true, if this formatter is able to format the given object.
	 */
	boolean isCompatible(Object object);

	/**
	 * Returns the object formatted into a String or null if this formatter is unable to format the object.
	 *
	 * @param object the input to both isCompatible(...) and toString(...).
	 * @return object formatted into a String or null if this formatter is unable to format the object.
	 */
	String toString(Object object);
}