Package org.faktorips.runtime.xml

Interface IToXmlSupport

public interface IToXmlSupport

Interface for runtime objects implementing a method to write their properties to XML.

Method Summary

Modifier and Type	Method	Description
static void	check(Class<?> runtimeObjectClass)	This method may be used to write a check in a default toXml implementation.
static void	check(Object runtimeObject)	This method may be used to write a check in a default toXml implementation.
void	writePropertiesToXml(Element element)	Subclasses override this method to write their properties into the given XML element.

Method Details

writePropertiesToXml

void writePropertiesToXml(Element element)

Subclasses override this method to write their properties into the given XML element.

The standard implementation throws an UnsupportedOperationException if the support for toXml ("Generate toXml Support") is not activated in the FIPS standard builder. Generated classes override but do NOT call super.

Parameters:

element - the XML element to write the properties to

check

static void check(Object runtimeObject)

This method may be used to write a check in a default toXml implementation.

Parameters:

runtimeObject - an object that might be an instance of IToXmlSupport

Throws:

UnsupportedOperationException - if the given runtimeObject is no instance of IToXmlSupport.

check

static void check(Class<?> runtimeObjectClass)

This method may be used to write a check in a default toXml implementation.

Parameters:

runtimeObjectClass - a class that might be assignable from IToXmlSupport

Throws:

UnsupportedOperationException - if the given runtimeObject is no instance of IToXmlSupport.