Module org.refcodes.struct.ext.factory

Package org.refcodes.struct.ext.factory

Class TomlCanonicalMapFactory

java.lang.Object

org.refcodes.struct.ext.factory.AbstractCanonicalMapFactory

org.refcodes.struct.ext.factory.TomlCanonicalMapFactory

All Implemented Interfaces:

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

Direct Known Subclasses:

TomlCanonicalMapFactorySingleton

public class TomlCanonicalMapFactory
extends AbstractCanonicalMapFactory
implements CanonicalMapFactory

Implementation of the CanonicalMapFactory interface with support of so called "TOML properties". In addition, nested sections are supported: A section represents the first portion of a path and looks like such: [SectionA] ValueA=A This results in key/value property of: SectionA/ValueA=A [SectionA] ValueA=A [[SectionB]] ValueB=B SectionA/ValueA=A SectionA/SectionB/ValueB=B For TOML properties, see "https://en.wikipedia.org/wiki/TOML"

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

Modifier and Type	Field	Description
static char[]	COMMENTS
static char[]	DELIMITERS
static char	SECTION_BEGIN
static char	SECTION_END

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

COMMENT_PROPERTY, DELIMITER_PROPERTY, SUPPORTED_DELIMITERS_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TomlCanonicalMapFactory()

Method Summary

Modifier and Type	Method	Description
org.refcodes.struct.CanonicalMap.CanonicalMapBuilder	fromMarshaled(InputStream aExternalRepresentation)
org.refcodes.struct.CanonicalMap.CanonicalMapBuilder	fromMarshaled(InputStream aExternalRepresentation, Map<String,String> aProperties)
InputStream	fromUnmarshaled(org.refcodes.struct.CanonicalMap aDataStructure)
InputStream	fromUnmarshaled(org.refcodes.struct.CanonicalMap aDataStructure, Map<String,String> aProperties)
String	toMarshaled(org.refcodes.struct.CanonicalMap aDataStructure)
String	toMarshaled(org.refcodes.struct.CanonicalMap aDataStructure, Map<String,String> aProperties)

Methods inherited from class org.refcodes.struct.ext.factory.AbstractCanonicalMapFactory

postProcess, toComment, toDelimiter, toInputStream, toString, toSupportedDelimiters, toXml

Methods inherited from class java.lang.Object

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

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

toUnmarshaled, toUnmarshaled

Field Detail

SECTION_BEGIN

public static final char SECTION_BEGIN

See Also:

Constant Field Values

SECTION_END

public static final char SECTION_END

See Also:

Constant Field Values

COMMENTS

public static final char[] COMMENTS

DELIMITERS

public static final char[] DELIMITERS

Constructor Detail

TomlCanonicalMapFactory

public TomlCanonicalMapFactory()

Method Detail

fromMarshaled

public org.refcodes.struct.CanonicalMap.CanonicalMapBuilder fromMarshaled(InputStream aExternalRepresentation)
                                                                   throws org.refcodes.exception.UnmarshalException

Specified by:

fromMarshaled in interface org.refcodes.factory.UnmarshalTypeFactory.UnmarshalTypeFactoryComplement<org.refcodes.struct.CanonicalMap.CanonicalMapBuilder,InputStream>

Throws:

org.refcodes.exception.UnmarshalException

fromMarshaled

public org.refcodes.struct.CanonicalMap.CanonicalMapBuilder fromMarshaled(InputStream aExternalRepresentation,
                                                                          Map<String,String> aProperties)
                                                                   throws org.refcodes.exception.UnmarshalException

Specified by:

fromMarshaled in interface org.refcodes.factory.UnmarshalTypeFactory.UnmarshalTypeFactoryComplement<org.refcodes.struct.CanonicalMap.CanonicalMapBuilder,InputStream>

Throws:

org.refcodes.exception.UnmarshalException

toMarshaled

public String toMarshaled(org.refcodes.struct.CanonicalMap aDataStructure)
                   throws org.refcodes.exception.MarshalException

Specified by:

toMarshaled in interface CanonicalMapFactory

Specified by:

toMarshaled in interface org.refcodes.factory.MarshalTypeFactory<org.refcodes.struct.CanonicalMap,String>

Throws:

org.refcodes.exception.MarshalException

toMarshaled

public String toMarshaled(org.refcodes.struct.CanonicalMap aDataStructure,
                          Map<String,String> aProperties)
                   throws org.refcodes.exception.MarshalException

Specified by:

toMarshaled in interface CanonicalMapFactory

Specified by:

toMarshaled in interface org.refcodes.factory.MarshalTypeFactory<org.refcodes.struct.CanonicalMap,String>

Throws:

org.refcodes.exception.MarshalException

fromUnmarshaled

public InputStream fromUnmarshaled(org.refcodes.struct.CanonicalMap aDataStructure)
                            throws org.refcodes.exception.MarshalException

Specified by:

fromUnmarshaled in interface org.refcodes.factory.MarshalTypeFactory.MarshalTypeFactoryComplement<org.refcodes.struct.CanonicalMap,InputStream>

Throws:

org.refcodes.exception.MarshalException

fromUnmarshaled

public InputStream fromUnmarshaled(org.refcodes.struct.CanonicalMap aDataStructure,
                                   Map<String,String> aProperties)
                            throws org.refcodes.exception.MarshalException

Specified by:

fromUnmarshaled in interface org.refcodes.factory.MarshalTypeFactory.MarshalTypeFactoryComplement<org.refcodes.struct.CanonicalMap,InputStream>

Throws:

org.refcodes.exception.MarshalException