/**
 * Copyright (c) 2014, the Railo Company Ltd.
 * Copyright (c) 2015, Lucee Assosication Switzerland
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either 
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public 
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 * 
 */
package lucee.runtime.op;

import java.io.Serializable;

import lucee.runtime.exp.PageException;
import lucee.runtime.type.dt.DateTime;

/**
 * Interface to define a Object as Castable, for Lucee Type Casts
 */
public interface Castable extends Serializable {

	/**
	 * cast the castable value to a string, other than the Method toString, this
	 * Method can throw a Exception
	 * 
	 * @return String representation of the Object
	 * @throws PageException
	 */
	public String castToString() throws PageException;

	/**
	 * cast the castable value to a string, return the default value, when the
	 * method is not castable
	 * 
	 * @return String representation of the Object
	 */
	public String castToString(String defaultValue);

	/**
	 * cast the castable value to a boolean value
	 * 
	 * @return boolean Value representation of the Object
	 * @throws PageException
	 */
	public boolean castToBooleanValue() throws PageException;

	/**
	 * cast the castable value to a boolean value
	 * 
	 * @return boolean Value representation of the Object
	 */
	public Boolean castToBoolean(Boolean defaultValue);

	/**
	 * cast the castable value to a double value
	 * 
	 * @return double Value representation of the Object
	 * @throws PageException
	 */
	public double castToDoubleValue() throws PageException;

	/**
	 * cast the castable value to a double value
	 * 
	 * @return double Value representation of the Object
	 */
	public double castToDoubleValue(double defaultValue);

	/**
	 * cast the castable value to a date time object
	 * 
	 * @return date time representation of the Object
	 * @throws PageException
	 */
	public DateTime castToDateTime() throws PageException;

	/**
	 * cast the castable value to a date time object
	 * 
	 * @param defaultValue returned when it is not possible to cast to a
	 *            dateTime object
	 * @return date time representation of the Object
	 */
	public DateTime castToDateTime(DateTime defaultValue);

	public int compareTo(String str) throws PageException;

	public int compareTo(boolean b) throws PageException;

	public int compareTo(double d) throws PageException;

	public int compareTo(DateTime dt) throws PageException;

}
/**
 * Copyright (c) 2014, the Railo Company Ltd.
 * Copyright (c) 2015, Lucee Assosication Switzerland
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either 
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public 
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 * 
 */
package lucee.runtime.op;

import java.io.Serializable;

import lucee.runtime.exp.PageException;
import lucee.runtime.type.dt.DateTime;

/**
 * Interface to define a Object as Castable, for Lucee Type Casts
 */
public interface Castable extends Serializable {

	/**
	 * cast the castable value to a string, other than the Method toString, this
	 * Method can throw a Exception
	 * 
	 * @return String representation of the Object
	 * @throws PageException thrown when fail to convert to a string
	 */
	public String castToString() throws PageException;

	/**
	 * cast the castable value to a string, return the default value, when the
	 * method is not castable
	 * 
	 * @param defaultValue default value returned in case not able to convert to a string
	 * @return String representation of the Object
	 */
	public String castToString(String defaultValue);

	/**
	 * cast the castable value to a boolean value
	 * 
	 * @return boolean Value representation of the Object
	 * @throws PageException thrown when fail to convert to a boolean
	 */
	public boolean castToBooleanValue() throws PageException;

	/**
	 * cast the castable value to a boolean value
	 * 
	 * @param defaultValue default value returned in case not able to convert to a boolean
	 * @return boolean Value representation of the Object
	 */
	public Boolean castToBoolean(Boolean defaultValue);

	/**
	 * cast the castable value to a double value
	 * 
	 * @return double Value representation of the Object
	 * @throws PageException thrown when fail to convert to a double value
	 */
	public double castToDoubleValue() throws PageException;

	/**
	 * cast the castable value to a double value
	 * 
	 * @param defaultValue default value returned in case not able to convert to a date object
	 * @return double Value representation of the Object
	 */
	public double castToDoubleValue(double defaultValue);

	/**
	 * cast the castable value to a date time object
	 * 
	 * @return date time representation of the Object
	 * @throws PageException thrown when fails to convert to a date object
	 */
	public DateTime castToDateTime() throws PageException;

	/**
	 * cast the castable value to a date time object
	 * 
	 * @param defaultValue returned when it is not possible to cast to a
	 *            dateTime object
	 * @return date time representation of the Object
	 */
	public DateTime castToDateTime(DateTime defaultValue);

	public int compareTo(String str) throws PageException;

	public int compareTo(boolean b) throws PageException;

	public int compareTo(double d) throws PageException;

	public int compareTo(DateTime dt) throws PageException;

}
improve javadoc comments