com.saperion.ngc.favorites

Enum FavoriteXmlHandler

java.lang.Object

java.lang.Enum<FavoriteXmlHandler>

com.saperion.ngc.favorites.FavoriteXmlHandler

All Implemented Interfaces:

Serializable, Comparable<FavoriteXmlHandler>

public enum FavoriteXmlHandler
extends Enum<FavoriteXmlHandler>

XML Handler to perform xml to java binding.

Author:

mak

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE singleton instance.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FAVORITES_XML favorites xml file name.

Method Summary

Modifier and Type	Method and Description
Favorites	getAdaptedFavorites(InputStream stream) Converts the given favorites xml stream to java binding and adds additional information (converts the string data to the real data types).
String	marshal(Favorites favorites) Converts the given favorites java object to xml binding.
com.saperion.rmi.SaContentStream	marshalToStream(Favorites favorites) Converts the given favorites java object to xml binding.
Favorites	unmarshal(InputStream stream) Converts the given favorites xml stream to java binding.
Favorites	unmarshal(String xml) Converts the given favorites xml string to java binding.
static FavoriteXmlHandler	valueOf(String name) Returns the enum constant of this type with the specified name.
static FavoriteXmlHandler[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final FavoriteXmlHandler INSTANCE

singleton instance.

Field Detail

FAVORITES_XML

public static final String FAVORITES_XML

favorites xml file name.

See Also:

Constant Field Values

Method Detail

values

public static FavoriteXmlHandler[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FavoriteXmlHandler c : FavoriteXmlHandler.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FavoriteXmlHandler valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

unmarshal

public Favorites unmarshal(String xml)
                    throws JAXBException

Converts the given favorites xml string to java binding.

Parameters:

xml - the favorites xml string

Returns:

Favorites element root

Throws:

JAXBException - JAXBException

unmarshal

public Favorites unmarshal(InputStream stream)
                    throws JAXBException

Converts the given favorites xml stream to java binding.

Parameters:

stream - the favorites xml stream

Returns:

Favorites element root

Throws:

JAXBException - JAXBException

getAdaptedFavorites

public Favorites getAdaptedFavorites(InputStream stream)
                              throws JAXBException,
                                     FavoriteReadException

Converts the given favorites xml stream to java binding and adds additional information (converts the string data to the real data types).

Parameters:

stream - the favorites xml stream

Returns:

Favorites element root

Throws:

JAXBException - JAXBException

FavoriteReadException - favorite settings could not be read

marshal

public String marshal(Favorites favorites)
               throws JAXBException

Converts the given favorites java object to xml binding.

Parameters:

favorites - Favorites element root

Returns:

the favorites xml string

Throws:

JAXBException - JAXBException

marshalToStream

public com.saperion.rmi.SaContentStream marshalToStream(Favorites favorites)
                                                 throws JAXBException

Converts the given favorites java object to xml binding.

Parameters:

favorites - Favorites element root

Returns:

the favorites file content stream

Throws:

JAXBException - JAXBException