/**
* Copyright (C) 2002-2012 The FreeCol Team
*
* This file is part of FreeCol.
*
* FreeCol 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
* (at your option) any later version.
*
* FreeCol 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 FreeCol. If not, see <http://www.gnu.org/licenses/>.
*/
package net.sf.freecol.common.option;
import org.freecolandroid.xml.stream.XMLStreamException;
import org.freecolandroid.xml.stream.XMLStreamReader;
import org.freecolandroid.xml.stream.XMLStreamWriter;
/**
* An option describes something which can be customized by the user.
*
* @see net.sf.freecol.common.model.GameOptions
*/
public interface Option<T> extends Cloneable {
/**
* Returns a textual representation of this object.
* @return The name of this <code>Option</code>.
*/
public String toString() ;
/**
* Returns the id of this <code>Option</code>.
* @return The unique identifier as provided in the constructor.
*/
public String getId();
/**
* Returns the value of this Option.
*
* @return the value of this Option
*/
public T getValue();
/**
* Sets the value of this Option.
*
* @param value the value of this Option
*/
public void setValue(T value);
public Option<T> clone() throws CloneNotSupportedException;
/**
* Initializes this object from an XML-representation of this object.
* @param in The input stream with the XML.
* @throws XMLStreamException if there are any problems writing
* to the stream.
*/
public void readFromXML(XMLStreamReader in) throws XMLStreamException;
/**
* Makes an XML-representation of this object.
*
* @param out The output stream.
* @throws XMLStreamException if there are any problems writing
* to the stream.
*/
public void toXML(XMLStreamWriter out) throws XMLStreamException;
}