Gridarta Editor
net.sf.gridarta.plugin.parameter.PluginParameterCodec< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R > Class Template Reference

Converts PluginParameters from or to XML encoding. More...

+ Inheritance diagram for net.sf.gridarta.plugin.parameter.PluginParameterCodec< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:
+ Collaboration diagram for net.sf.gridarta.plugin.parameter.PluginParameterCodec< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >:

Public Member Functions

void fromXML (@NotNull final PluginParameter< G, A, R, ?> parameter, @NotNull final Element e)
 Restores a PluginParameter from XML representation. More...
 
Element toXML (@NotNull final PluginParameter< G, A, R, ?> parameter)
 Returns the XML representation of a PluginParameter. More...
 

Private Member Functions

String getChildText (@NotNull final String key, @NotNull final String defaultValue)
 Returns the value of a field of e. More...
 

Private Attributes

Element e
 Holds the XML representation being decoded. More...
 
final PluginParameterVisitor< G, A, R, PluginParameter< G, A, R, ?> > fromXML
 A PluginParameterVisitor that restores a PluginParameter from XML representation. More...
 
final PluginParameterVisitor< G, A, R, Element > toXML
 A PluginParameterVisitor that returns XML representation. More...
 

Detailed Description

Converts PluginParameters from or to XML encoding.

Author
tchize
Andreas Kirschbaum

Definition at line 35 of file PluginParameterCodec.java.

Member Function Documentation

◆ fromXML()

void net.sf.gridarta.plugin.parameter.PluginParameterCodec< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.fromXML ( @NotNull final PluginParameter< G, A, R, ?>  parameter,
@NotNull final Element  e 
)

Restores a PluginParameter from XML representation.

Parameters
parameterthe plugin parameter to restore
ethe XML representation

Definition at line 266 of file PluginParameterCodec.java.

◆ getChildText()

String net.sf.gridarta.plugin.parameter.PluginParameterCodec< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.getChildText ( @NotNull final String  key,
@NotNull final String  defaultValue 
)
private

Returns the value of a field of e.

Parameters
keythe key of the field
defaultValuethe default value if the field is missing
Returns
the value

Definition at line 279 of file PluginParameterCodec.java.

◆ toXML()

Element net.sf.gridarta.plugin.parameter.PluginParameterCodec< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.toXML ( @NotNull final PluginParameter< G, A, R, ?>  parameter)

Returns the XML representation of a PluginParameter.

Parameters
parameterthe plugin parameter to encode
Returns
the plugin parameter in XML repfresentation

Definition at line 257 of file PluginParameterCodec.java.

Member Data Documentation

◆ e

Element net.sf.gridarta.plugin.parameter.PluginParameterCodec< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.e
private

Holds the XML representation being decoded.

Definition at line 249 of file PluginParameterCodec.java.

Referenced by net.sf.gridarta.plugin.parameter.PluginParameterCodec< G, A, R >.fromXML().

◆ fromXML

◆ toXML


The documentation for this class was generated from the following file: