Package org.faktorips.runtime

Class IpsEnumToXmlWriter

java.lang.Object

org.faktorips.runtime.IpsEnumToXmlWriter

public class IpsEnumToXmlWriter
extends Object

This class is used in generated code for enums to write their values to XML when the generator setting "Generate toXml Support" is activated.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_ELEMENT_ENUMATTRIBUTEVALUE

Constructor Summary

Constructors

Constructor	Description
IpsEnumToXmlWriter(IRuntimeRepository repository, Class<?> enumClass)	To save an extensible enum to XML, all instances need to be loaded from the IRuntimeRepository therefore we require non-null parameters.
IpsEnumToXmlWriter(IRuntimeRepository repository, Class<?> enumClass, List<?> enumValues)	To save an extensible enum to XML, all instances need to be loaded from the IRuntimeRepository therefore we require non-null parameters.

Method Summary

Modifier and Type	Method	Description
Element	toXml(Document document)	Creates an XML Element that represents this enums data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XML_ELEMENT_ENUMATTRIBUTEVALUE

public static final String XML_ELEMENT_ENUMATTRIBUTEVALUE

See Also:

• Constant Field Values

Constructor Details

IpsEnumToXmlWriter

public IpsEnumToXmlWriter(IRuntimeRepository repository,
 Class<?> enumClass)

To save an extensible enum to XML, all instances need to be loaded from the IRuntimeRepository therefore we require non-null parameters.

Parameters:

repository - the repository

enumClass - the enum class

IpsEnumToXmlWriter

public IpsEnumToXmlWriter(IRuntimeRepository repository,
 Class<?> enumClass,
 List<?> enumValues)

To save an extensible enum to XML, all instances need to be loaded from the IRuntimeRepository therefore we require non-null parameters.

Parameters:

repository - the repository

enumClass - the enum class

enumValues - the value of the enum type as list

Method Details

toXml

public Element toXml(Document document)

Creates an XML Element that represents this enums data.

Parameters:

document - a document, that can be used to create XML elements.

Throws:

UnsupportedOperationException - if the support for toXml ("Generate toXml Support") is not activated in the Faktor-IPS standard builder.