com.adaptris.core.marshaller.xstream

Class XStreamUtils

java.lang.Object

com.adaptris.core.marshaller.xstream.XStreamUtils

public abstract class XStreamUtils
extends java.lang.Object

General Utilities used by various XStream related classes

Constructor Summary

Constructors

Constructor and Description
XStreamUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.Collection<java.lang.String>	createParentFields(java.lang.Class<?> clazz, java.lang.String field, java.lang.String separator) Given a Field of a Class this method will return a Set of a number of possible fully qualified reference names for the field.
static java.util.List<java.lang.Class<?>>	getClasses(java.io.InputStream in) Reads in the given resource file and converts each line of input into a Class.
static java.util.List<java.lang.String>	readResource(java.io.InputStream in) Reads in the entire file contents skipping any blank lines.
static boolean	setContainsAnyOf(java.util.Set<java.lang.String> toCheck, java.util.Collection<java.lang.String> possibles) Determine if the given Set toCheck contains any of the elements within possibles
static java.lang.String	toFieldName(java.lang.String xmlElementName) Converts a lowercase hyphen separated format into a camelcase based format.
static java.lang.String	toXmlElementName(java.lang.String fieldName) Converts a camelcase name into a lowercase hyphen separated format for output to XML.

Methods inherited from class java.lang.Object

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

Constructor Detail

XStreamUtils

public XStreamUtils()

Method Detail

toFieldName

public static java.lang.String toFieldName(java.lang.String xmlElementName)

Converts a lowercase hyphen separated format into a camelcase based format. Used by the unmarshalling process to convert an xml element into a java class/field name.

Parameters:

xmlElementName - - Current element name to be processed.

Returns:

translated name

toXmlElementName

public static java.lang.String toXmlElementName(java.lang.String fieldName)

Converts a camelcase name into a lowercase hyphen separated format for output to XML. Used by the marshalling process to convert a java class/field name into an xml element name.

Parameters:

fieldName - - Current element name to be processed.

Returns:

translated name

createParentFields

public static java.util.Collection<java.lang.String> createParentFields(java.lang.Class<?> clazz,
                                                                        java.lang.String field,
                                                                        java.lang.String separator)

Given a Field of a Class this method will return a Set of a number of possible fully qualified reference names for the field. This would be based on the class hierarchy eg currentClass:field, parentClass:field, grandparentClass:field etc.

Parameters:

clazz - - Parent Class of the given field

field - - Given field to process

separator - - class-field separator

Returns:

- Set of possible paths for the field

setContainsAnyOf

public static boolean setContainsAnyOf(java.util.Set<java.lang.String> toCheck,
                                       java.util.Collection<java.lang.String> possibles)

Determine if the given Set toCheck contains any of the elements within possibles

Parameters:

toCheck - - Set of Strings to check

possibles - - Collection of

Returns:

true if the set contains the possibles.

readResource

public static java.util.List<java.lang.String> readResource(java.io.InputStream in)
                                                     throws java.io.IOException

Reads in the entire file contents skipping any blank lines.

Parameters:

in - - InputStream to read

Returns:

List List of lines.

Throws:

java.io.IOException

getClasses

public static java.util.List<java.lang.Class<?>> getClasses(java.io.InputStream in)
                                                     throws java.io.IOException

Reads in the given resource file and converts each line of input into a Class.

Parameters:

in - - Opened input stream to resource file

Returns:

List of Classes

Throws:

java.io.IOException