com.alee.utils

Class XmlUtils

java.lang.Object

com.alee.utils.XmlUtils

public final class XmlUtils
extends Object

This class provides a set of utilities to easily serialize and deserialize objects into and from XML. There are is a lot of methods to read specific library objects using various resource files.

Author:

Mikle Garin

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_ATTRIBUTE
static String	CONTEXT_BASE
static String	CONTEXT_NEAR_CLASS Resource-related context values.
static String	NEAR_CLASS_ATTRIBUTE Resource attributes.
static String	PATH_ATTRIBUTE
static String	URL_ATTRIBUTE

Method Summary

Modifier and Type	Method and Description
static void	addImplicitArray(Class type, String field) Adds an implicit array.
static void	addImplicitArray(Class type, String field, String itemName) Adds an implicit array which is used for all items of the given element name defined by itemName.
static <T extends AliasProvider> void	alias(Class<T> aliasProvider) Calls static "provideAliases" method on a class that implements AliasProvider.
static void	alias(String name, Class type) Alias a Class to a shorter name to be used in XML elements.
static <T> T	fromXML(InputStream input) Returns Object deserialized from XML content.
static <T> T	fromXML(InputStream input, Object root) Returns Object deserialized from XML content.
static <T> T	fromXML(InputStream input, XStreamContext context) Returns Object deserialized from XML content.
static <T> T	fromXML(Reader reader) Returns Object deserialized from XML content.
static <T> T	fromXML(Reader reader, Object root) Returns Object deserialized from XML content.
static <T> T	fromXML(Reader reader, XStreamContext context) Returns Object deserialized from XML content.
static <T> T	fromXML(Resource resource) Returns Object deserialized from XML text.
static <T> T	fromXML(Resource resource, Object root) Returns Object deserialized from XML text.
static <T> T	fromXML(Resource resource, XStreamContext context) Returns Object deserialized from XML text.
static <T> T	fromXML(String xml) Returns Object deserialized from XML content.
static <T> T	fromXML(String xml, Object root) Returns Object deserialized from XML content.
static <T> T	fromXML(String xml, XStreamContext context) Returns Object deserialized from XML content.
static com.thoughtworks.xstream.XStream	getXStream() Returns global XStream instance configured with all required aliases and converters.
static boolean	isAliasJdkClasses() Returns whether or not aliases for standard JDK classes like Point and Rectangle are used.
static void	omitField(Class type, String field) Prevents field from being serialized.
static void	processAnnotations(Class type) Process the annotations of the given type and configure the XStream.
static void	processAnnotations(Class[] types) Process the annotations of the given types and configure the XStream.
static Resource	readResource(com.thoughtworks.xstream.io.HierarchicalStreamReader reader, com.thoughtworks.xstream.converters.UnmarshallingContext context, com.thoughtworks.xstream.mapper.Mapper mapper) Returns Resource based on the available attributes in the current node.
static void	registerConverter(com.thoughtworks.xstream.converters.Converter converter) Adds a new converter into converters registry.
static void	registerConverter(com.thoughtworks.xstream.converters.SingleValueConverter converter) Adds a new converter into converters registry.
static void	setAliasJdkClasses(boolean alias) Sets whether or not aliases for standard JDK classes like Point and Rectangle should be used.
static String	toXML(Object obj) Returns Object serialized into XML.
static void	toXML(Object obj, File file) Serializes Object into XML and writes it into specified file.
static void	toXML(Object obj, com.thoughtworks.xstream.io.HierarchicalStreamWriter writer) Serializes Object into XML and writes it using a specified HierarchicalStreamWriter
static void	toXML(Object obj, OutputStream out) Serializes Object into XML and writes it using a specified OutputStream.
static void	toXML(Object obj, String file) Serializes Object into XML and writes it into specified file.
static void	toXML(Object obj, Writer out) Serializes Object into XML and writes it using a specified Writer.
static void	useAttributeFor(Class type, String field) Use an attribute for a field declared in a specific type.

Methods inherited from class java.lang.Object

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

Field Detail

NEAR_CLASS_ATTRIBUTE

public static final String NEAR_CLASS_ATTRIBUTE

Resource attributes.

See Also:

Constant Field Values

BASE_ATTRIBUTE

public static final String BASE_ATTRIBUTE

See Also:

Constant Field Values

PATH_ATTRIBUTE

public static final String PATH_ATTRIBUTE

See Also:

Constant Field Values

URL_ATTRIBUTE

public static final String URL_ATTRIBUTE

See Also:

Constant Field Values

CONTEXT_NEAR_CLASS

public static final String CONTEXT_NEAR_CLASS

Resource-related context values.

See Also:

Constant Field Values

CONTEXT_BASE

public static final String CONTEXT_BASE

See Also:

Constant Field Values

Method Detail

getXStream

@NotNull
public static com.thoughtworks.xstream.XStream getXStream()

Returns global XStream instance configured with all required aliases and converters.

Returns:

XStream

isAliasJdkClasses

public static boolean isAliasJdkClasses()

Returns whether or not aliases for standard JDK classes like Point and Rectangle are used.

Returns:

true if should use aliases for standard JDK classes are used, false otherwise

setAliasJdkClasses

public static void setAliasJdkClasses(boolean alias)

Sets whether or not aliases for standard JDK classes like Point and Rectangle should be used.

Parameters:

alias - whether or not aliases for standard JDK classes should be used

processAnnotations

public static void processAnnotations(@NotNull
                                      Class type)

Process the annotations of the given type and configure the XStream. A call of this method will automatically turn the auto-detection mode for annotations off.

Parameters:

type - the type with XStream annotations

processAnnotations

public static void processAnnotations(@NotNull
                                      Class[] types)

Process the annotations of the given types and configure the XStream.

Parameters:

types - the types with XStream annotations

alias

public static void alias(@NotNull
                         String name,
                         @NotNull
                         Class type)

Alias a Class to a shorter name to be used in XML elements.

Parameters:

name - Short name

type - Type to be aliased

omitField

public static void omitField(@NotNull
                             Class type,
                             @NotNull
                             String field)

Prevents field from being serialized.

Parameters:

type - class owning the field

field - name of the field

useAttributeFor

public static void useAttributeFor(@NotNull
                                   Class type,
                                   @NotNull
                                   String field)

Use an attribute for a field declared in a specific type.

Parameters:

type - the name of the field

field - the Class containing such field

addImplicitArray

public static void addImplicitArray(@NotNull
                                    Class type,
                                    @NotNull
                                    String field)

Adds an implicit array.

Parameters:

type - class owning the implicit array

field - name of the array field

addImplicitArray

public static void addImplicitArray(@NotNull
                                    Class type,
                                    @NotNull
                                    String field,
                                    @NotNull
                                    String itemName)

Adds an implicit array which is used for all items of the given element name defined by itemName.

Parameters:

type - class owning the implicit array

field - name of the array field in the ownerType

itemName - alias name of the items

registerConverter

public static void registerConverter(@NotNull
                                     com.thoughtworks.xstream.converters.Converter converter)

Adds a new converter into converters registry.

Parameters:

converter - the new converter

registerConverter

public static void registerConverter(@NotNull
                                     com.thoughtworks.xstream.converters.SingleValueConverter converter)

Adds a new converter into converters registry.

Parameters:

converter - the new converter

alias

public static <T extends AliasProvider> void alias(@NotNull
                                                   Class<T> aliasProvider)

Calls static "provideAliases" method on a class that implements AliasProvider. This method is created mostly for internal library usage.

Type Parameters:

T - specific class type

Parameters:

aliasProvider - AliasProvider ancestor class

fromXML

public static <T> T fromXML(@NotNull
                            String xml)

Returns Object deserialized from XML content.

Type Parameters:

T - read object type

Parameters:

xml - XML content

Returns:

deserialized object

fromXML

public static <T> T fromXML(@NotNull
                            String xml,
                            @NotNull
                            Object root)

Returns Object deserialized from XML content.

Type Parameters:

T - read object type

Parameters:

xml - XML content

root - root Object

Returns:

deserialized object

fromXML

public static <T> T fromXML(@NotNull
                            String xml,
                            @Nullable
                            XStreamContext context)

Returns Object deserialized from XML content.

Type Parameters:

T - read object type

Parameters:

xml - XML content

context - unmarshalling context data

Returns:

deserialized object

fromXML

public static <T> T fromXML(@NotNull
                            Resource resource)

Returns Object deserialized from XML text.

Type Parameters:

T - read object type

Parameters:

resource - Resource

Returns:

deserialized object

fromXML

public static <T> T fromXML(@NotNull
                            Resource resource,
                            @NotNull
                            Object root)

Returns Object deserialized from XML text.

Type Parameters:

T - read object type

Parameters:

resource - Resource

root - root Object

Returns:

deserialized object

fromXML

public static <T> T fromXML(@NotNull
                            Resource resource,
                            @Nullable
                            XStreamContext context)

Returns Object deserialized from XML text.

Type Parameters:

T - read object type

Parameters:

resource - Resource

context - unmarshalling context data

Returns:

deserialized object

fromXML

public static <T> T fromXML(@NotNull
                            InputStream input)

Returns Object deserialized from XML content.

Type Parameters:

T - read object type

Parameters:

input - XML text source

Returns:

deserialized object

fromXML

public static <T> T fromXML(@NotNull
                            InputStream input,
                            @NotNull
                            Object root)

Returns Object deserialized from XML content.

Type Parameters:

T - read object type

Parameters:

input - XML text source

root - root Object

Returns:

deserialized object

fromXML

public static <T> T fromXML(@NotNull
                            InputStream input,
                            @Nullable
                            XStreamContext context)

Returns Object deserialized from XML content.

Type Parameters:

T - read object type

Parameters:

input - XML text source

context - unmarshalling context data

Returns:

deserialized object

fromXML

public static <T> T fromXML(@NotNull
                            Reader reader)

Returns Object deserialized from XML content.

Type Parameters:

T - read object type

Parameters:

reader - XML text source

Returns:

deserialized object

fromXML

public static <T> T fromXML(@NotNull
                            Reader reader,
                            @NotNull
                            Object root)

Returns Object deserialized from XML content.

Type Parameters:

T - read object type

Parameters:

reader - XML text source

root - root Object

Returns:

deserialized object

fromXML

public static <T> T fromXML(@NotNull
                            Reader reader,
                            @Nullable
                            XStreamContext context)

Returns Object deserialized from XML content.

Type Parameters:

T - read object type

Parameters:

reader - XML text source

context - unmarshalling context data

Returns:

deserialized object

toXML

public static void toXML(@NotNull
                         Object obj,
                         @NotNull
                         String file)

Serializes Object into XML and writes it into specified file.

Parameters:

obj - object to serialize

file - output file

toXML

public static void toXML(@NotNull
                         Object obj,
                         @NotNull
                         File file)

Serializes Object into XML and writes it into specified file.

Parameters:

obj - object to serialize

file - output file

toXML

@NotNull
public static String toXML(@NotNull
                                    Object obj)

Returns Object serialized into XML.

Parameters:

obj - object to serialize

Returns:

serialized into XML object representation

toXML

public static void toXML(@NotNull
                         Object obj,
                         @NotNull
                         Writer out)

Serializes Object into XML and writes it using a specified Writer.

Parameters:

obj - object to serialize

out - output writer

toXML

public static void toXML(@NotNull
                         Object obj,
                         @NotNull
                         OutputStream out)

Serializes Object into XML and writes it using a specified OutputStream.

Parameters:

obj - object to serialize

out - output stream

toXML

public static void toXML(@NotNull
                         Object obj,
                         @NotNull
                         com.thoughtworks.xstream.io.HierarchicalStreamWriter writer)

Serializes Object into XML and writes it using a specified HierarchicalStreamWriter

Parameters:

obj - object to serialize

writer - hierarchical stream writer

readResource

@NotNull
public static Resource readResource(@NotNull
                                             com.thoughtworks.xstream.io.HierarchicalStreamReader reader,
                                             @NotNull
                                             com.thoughtworks.xstream.converters.UnmarshallingContext context,
                                             @NotNull
                                             com.thoughtworks.xstream.mapper.Mapper mapper)

Returns Resource based on the available attributes in the current node.

Parameters:

reader - HierarchicalStreamReader

context - UnmarshallingContext

mapper - Mapper

Returns:

Resource based on the available attributes in the current node