Package org.refcodes.structure.ext.factory

Class AbstractCanonicalMapFactory

java.lang.Object

org.refcodes.structure.ext.factory.AbstractCanonicalMapFactory

All Implemented Interfaces:

org.refcodes.factory.MarshalTypeFactory<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,String>, org.refcodes.factory.MarshalTypeFactory.MarshalTypeFactoryComplement<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,String>, org.refcodes.factory.MarshalTypeFactory.MarshalTypeFactoryComposite<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,String,InputStream>, org.refcodes.factory.UnmarshalTypeFactory<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,String>, org.refcodes.factory.UnmarshalTypeFactory.UnmarshalTypeFactoryComplement<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,String>, org.refcodes.factory.UnmarshalTypeFactory.UnmarshalTypeFactoryComposite<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,String,InputStream>, CanonicalMapFactory

Direct Known Subclasses:

HtmlCanonicalMapFactory, JavaCanonicalMapFactory, JsonCanonicalMapFactory, TomlCanonicalMapFactory, XmlCanonicalMapFactory, YamlCanonicalMapFactory

public abstract class AbstractCanonicalMapFactory
extends Object
implements CanonicalMapFactory

Base class for the CanonicalMapFactory providing base functionality.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.factory.MarshalTypeFactory

org.refcodes.factory.MarshalTypeFactory.MarshalTypeFactoryComplement<T extends Object,C extends Object>, org.refcodes.factory.MarshalTypeFactory.MarshalTypeFactoryComposite<T extends Object,SRC extends Object,C extends Object>

Nested classes/interfaces inherited from interface org.refcodes.factory.UnmarshalTypeFactory

org.refcodes.factory.UnmarshalTypeFactory.UnmarshalTypeFactoryComplement<T extends Object,C extends Object>, org.refcodes.factory.UnmarshalTypeFactory.UnmarshalTypeFactoryComposite<T extends Object,SRC extends Object,C extends Object>

Field Summary

Fields inherited from interface org.refcodes.structure.ext.factory.CanonicalMapFactory

COMMENT_PROPERTY, DELIMITER_PROPERTY, SUPPORTED_DELIMITERS_PROPERTY

Constructor Summary

Constructors

Constructor	Description
AbstractCanonicalMapFactory()

Method Summary

Modifier and Type	Method	Description
protected void	postProcessAttributes(org.refcodes.structure.CanonicalMap.CanonicalMapBuilder aProperties)	This method takes care on giving nodes with children an own value: E.g.
protected String	toComment(Map<String,String> aProperties)	Retrieves the comment to be used in the header of the marshaled representation.
protected char	toDelimiter(Map<String,String> aProperties, char aDefaultDelimiter)	Retrieves the delimiter to be used for the data structure.
protected InputStream	toInputStream(String aString)	Converts the given String to an InputStream.
protected String	toString(InputStream aInputStream)	Converts the given InputStream to a String.
protected char[]	toSupportedDelimiters(Map<String,String> aProperties)	Retrieves the supported delimiters to be used when unmarshaling an external representation.
protected static String	toXml(org.refcodes.structure.CanonicalMap aCanonicalMap)	Converts a CanonicalMap to XML.

Methods inherited from interface org.refcodes.structure.ext.factory.CanonicalMapFactory

toMarshaled, toMarshaled, toUnmarshaled, toUnmarshaled

Methods inherited from interface org.refcodes.factory.MarshalTypeFactory.MarshalTypeFactoryComplement

fromUnmarshaled, fromUnmarshaled

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.factory.UnmarshalTypeFactory.UnmarshalTypeFactoryComplement

fromMarshaled, fromMarshaled

Constructor Detail

AbstractCanonicalMapFactory

public AbstractCanonicalMapFactory()

Method Detail

postProcessAttributes

protected void postProcessAttributes(org.refcodes.structure.CanonicalMap.CanonicalMapBuilder aProperties)

This method takes care on giving nodes with children an own value: E.g. "yaml" files cannot have a value for a node which has sub-nodes, same applies to "json" and "xml" which makes using the "mixed content" mechanism hard. When we require a value for a node (path) which may have sub-nodes (sub-paths), then e.g. a this sub-node assigns a value to it's parent node. E.g. For "xml", the attribute this="value" attached to an element takes care on giving an XML element with children an own value. See THIS_ATTRIBUTES.

Parameters:

aProperties - The properties where the "this" children are to assign a value to their parents.

toString

protected String toString(InputStream aInputStream)
                   throws IOException

Converts the given InputStream to a String.

Parameters:

aInputStream - The InputStream to be converted.

Returns:

The according String.

Throws:

IOException - thrown in case conversion failed.

toInputStream

protected InputStream toInputStream(String aString)

Converts the given String to an InputStream.

Parameters:

aString - The String to be converted.

Returns:

The according InputStream.

toDelimiter

protected char toDelimiter(Map<String,String> aProperties,
                           char aDefaultDelimiter)

Retrieves the delimiter to be used for the data structure.

Parameters:

aProperties - The properties from which to retrieve the delimiter.

aDefaultDelimiter - The delimiter to be used when there is none in the properties defined.

Returns:

The according delimiter or the PathMap.DELIMITER if none was provided in the properties.

toSupportedDelimiters

protected char[] toSupportedDelimiters(Map<String,String> aProperties)

Retrieves the supported delimiters to be used when unmarshaling an external representation.

Parameters:

aProperties - The properties from which to retrieve the supported delimiters. Them delimiters are provided in a String.

Returns:

The according supported delimiters or the PathMap.DELIMITER if none was provided in the properties.

toComment

protected String toComment(Map<String,String> aProperties)

Retrieves the comment to be used in the header of the marshaled representation.

Parameters:

aProperties - The properties from which to retrieve the comment.

Returns:

The according delimiter or the CanonicalMap.DEFAULT_COMMENT if none was provided in the properties.

toXml

protected static String toXml(org.refcodes.structure.CanonicalMap aCanonicalMap)

Converts a CanonicalMap to XML.

Parameters:

aCanonicalMap - The CanonicalMap to marshal.

Returns:

The resulting XML.