Package org.refcodes.structure.ext.factory

Interface CanonicalMapFactory

All Superinterfaces:

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

All Known Implementing Classes:

AbstractCanonicalMapFactory, HtmlCanonicalMapFactory, HtmlCanonicalMapFactorySingleton, JavaCanonicalMapFactory, JavaCanonicalMapFactorySingleton, JsonCanonicalMapFactory, JsonCanonicalMapFactorySingleton, TomlCanonicalMapFactory, TomlCanonicalMapFactorySingleton, XmlCanonicalMapFactory, XmlCanonicalMapFactorySingleton, YamlCanonicalMapFactory, YamlCanonicalMapFactorySingleton

public interface CanonicalMapFactory
extends org.refcodes.factory.UnmarshalTypeFactory.UnmarshalTypeFactoryComposite<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.lang.String,java.io.InputStream>, org.refcodes.factory.MarshalTypeFactory.MarshalTypeFactoryComposite<org.refcodes.structure.CanonicalMap,java.lang.String,java.io.InputStream>

The CanonicalMapFactory creates data structures from external representations and external representations from given data structures (using notations for the external representations as of the actual implementation of this interface).

Nested Class Summary

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

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	COMMENT_PROPERTY	Denoting a property specifying a comment.
static java.lang.String	DELIMITER_PROPERTY	Denoting a property specifying the valid delimiter characters all put in a String.
static java.lang.String	SUPPORTED_DELIMITERS_PROPERTY	Denoting a property specifying the valid delimiter characters all put in a String.

Method Summary

Modifier and Type	Method	Description
default java.lang.String	toMarshaled(org.refcodes.structure.CanonicalMap aDataStructure)
default java.lang.String	toMarshaled(org.refcodes.structure.CanonicalMap aDataStructure, java.util.Map<java.lang.String,java.lang.String> aProperties)
default org.refcodes.structure.CanonicalMap.CanonicalMapBuilder	toUnmarshaled(java.lang.String aExternalRepresentation)
default org.refcodes.structure.CanonicalMap.CanonicalMapBuilder	toUnmarshaled(java.lang.String aExternalRepresentation, java.util.Map<java.lang.String,java.lang.String> aProperties)

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

fromUnmarshaled, fromUnmarshaled

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

fromMarshaled, fromMarshaled

Field Detail

COMMENT_PROPERTY

static final java.lang.String COMMENT_PROPERTY

Denoting a property specifying a comment.

SUPPORTED_DELIMITERS_PROPERTY

static final java.lang.String SUPPORTED_DELIMITERS_PROPERTY

Denoting a property specifying the valid delimiter characters all put in a String.

DELIMITER_PROPERTY

static final java.lang.String DELIMITER_PROPERTY

Denoting a property specifying the valid delimiter characters all put in a String.

Method Detail

toUnmarshaled

default org.refcodes.structure.CanonicalMap.CanonicalMapBuilder toUnmarshaled(java.lang.String aExternalRepresentation)
                                                                       throws org.refcodes.exception.UnmarshalException

Specified by:

toUnmarshaled in interface org.refcodes.factory.UnmarshalTypeFactory<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.lang.String>

Throws:

org.refcodes.exception.UnmarshalException

toUnmarshaled

default org.refcodes.structure.CanonicalMap.CanonicalMapBuilder toUnmarshaled(java.lang.String aExternalRepresentation,
                                                                              java.util.Map<java.lang.String,java.lang.String> aProperties)
                                                                       throws org.refcodes.exception.UnmarshalException

Specified by:

toUnmarshaled in interface org.refcodes.factory.UnmarshalTypeFactory<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.lang.String>

Throws:

org.refcodes.exception.UnmarshalException

toMarshaled

default java.lang.String toMarshaled(org.refcodes.structure.CanonicalMap aDataStructure,
                                     java.util.Map<java.lang.String,java.lang.String> aProperties)
                              throws org.refcodes.exception.MarshalException

Specified by:

toMarshaled in interface org.refcodes.factory.MarshalTypeFactory<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.lang.String>

Throws:

org.refcodes.exception.MarshalException

toMarshaled

default java.lang.String toMarshaled(org.refcodes.structure.CanonicalMap aDataStructure)
                              throws org.refcodes.exception.MarshalException

Specified by:

toMarshaled in interface org.refcodes.factory.MarshalTypeFactory<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.lang.String>

Throws:

org.refcodes.exception.MarshalException