|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.freecol.common.model.FreeColObject
net.sf.freecol.common.model.NationOptions
public class NationOptions
Nested Class Summary | |
---|---|
static class |
NationOptions.Advantages
National advantages for European players only. |
static class |
NationOptions.NationState
Nations may be available to all players, to AI players only, or to no players. |
Field Summary | |
---|---|
static int |
DEFAULT_NO_OF_EUROPEANS
The default number of European nations. |
Fields inherited from class net.sf.freecol.common.model.FreeColObject |
---|
ID_ATTRIBUTE_TAG |
Constructor Summary | |
---|---|
NationOptions()
|
Method Summary | |
---|---|
boolean |
canSelectColors()
Get the SelectColors value. |
static NationOptions |
getDefaults()
Describe getDefaults method here. |
NationOptions.Advantages |
getNationalAdvantages()
Get the NationalAdvantages value. |
java.util.Map<Nation,NationOptions.NationState> |
getNations()
Get the Nations value. |
NationOptions.NationState |
getNationState(Nation nation)
Get the NationState value of a particular Nation. |
static java.lang.String |
getXMLElementTagName()
|
void |
readFromXMLImpl(javax.xml.stream.XMLStreamReader in)
Initialize this object from an XML-representation of this object. |
void |
setNationalAdvantages(NationOptions.Advantages newNationalAdvantages)
Set the NationalAdvantages value. |
void |
setNations(java.util.Map<Nation,NationOptions.NationState> newNations)
Set the Nations value. |
void |
setNationState(Nation nation,
NationOptions.NationState state)
Set the NationState value of a particular Nation. |
void |
setSelectColors(boolean newSelectColors)
Set the SelectColors value. |
java.lang.String |
toString()
|
void |
toXMLImpl(javax.xml.stream.XMLStreamWriter out)
This method writes an XML-representation of this object to the given stream. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_NO_OF_EUROPEANS
Constructor Detail |
---|
public NationOptions()
Method Detail |
---|
public final java.util.Map<Nation,NationOptions.NationState> getNations()
Nations
value.
Map
valuepublic final void setNations(java.util.Map<Nation,NationOptions.NationState> newNations)
Nations
value.
newNations
- The new Nations value.public final NationOptions.Advantages getNationalAdvantages()
NationalAdvantages
value.
Advantages
valuepublic final void setNationalAdvantages(NationOptions.Advantages newNationalAdvantages)
NationalAdvantages
value.
newNationalAdvantages
- The new NationalAdvantages value.public final boolean canSelectColors()
SelectColors
value.
boolean
valuepublic final void setSelectColors(boolean newSelectColors)
SelectColors
value.
newSelectColors
- The new SelectColors value.public final NationOptions.NationState getNationState(Nation nation)
NationState
value of a particular Nation.
nation
- a Nation
value
NationState
valuepublic final void setNationState(Nation nation, NationOptions.NationState state)
NationState
value of a particular Nation.
nation
- a Nation
valuestate
- a NationState
valuepublic static final NationOptions getDefaults()
getDefaults
method here.
NationOptions
valuepublic final void readFromXMLImpl(javax.xml.stream.XMLStreamReader in) throws javax.xml.stream.XMLStreamException
in
- The input stream with the XML.
javax.xml.stream.XMLStreamException
- if a problem was encountered
during parsing.public void toXMLImpl(javax.xml.stream.XMLStreamWriter out) throws javax.xml.stream.XMLStreamException
out
- The target stream.
javax.xml.stream.XMLStreamException
- if there are any problems writing
to the stream.public static java.lang.String getXMLElementTagName()
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |