Module org.refcodes.struct.ext.factory
Package org.refcodes.struct.ext.factory

Interface CanonicalMapFactory

All Superinterfaces:
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>
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.struct.CanonicalMap.CanonicalMapBuilder,​String,​InputStream>, org.refcodes.factory.MarshalTypeFactory.MarshalTypeFactoryComposite<org.refcodes.struct.CanonicalMap,​String,​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 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 String COMMENT_PROPERTY
    Denoting a property specifying a comment.
    static String DELIMITER_PROPERTY
    Denoting a property specifying the valid delimiter characters all put in a String.
    static 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 String toMarshaled​(org.refcodes.struct.CanonicalMap aDataStructure)
    default String toMarshaled​(org.refcodes.struct.CanonicalMap aDataStructure, Map<String,​String> aProperties)
    default org.refcodes.struct.CanonicalMap.CanonicalMapBuilder toUnmarshaled​(String aExternalRepresentation)
    default org.refcodes.struct.CanonicalMap.CanonicalMapBuilder toUnmarshaled​(String aExternalRepresentation, Map<String,​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 Details

    • COMMENT_PROPERTY

      static final String COMMENT_PROPERTY
      Denoting a property specifying a comment.

    • SUPPORTED_DELIMITERS_PROPERTY

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

    • DELIMITER_PROPERTY

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

  • Method Details

    • toUnmarshaled

      default org.refcodes.struct.CanonicalMap.CanonicalMapBuilder toUnmarshaled​(String aExternalRepresentation) throws org.refcodes.exception.UnmarshalException
      Specified by:
      toUnmarshaled in interface org.refcodes.factory.UnmarshalTypeFactory<org.refcodes.struct.CanonicalMap.CanonicalMapBuilder,​String>
      Throws:
      org.refcodes.exception.UnmarshalException

    • toUnmarshaled

      default org.refcodes.struct.CanonicalMap.CanonicalMapBuilder toUnmarshaled​(String aExternalRepresentation, Map<String,​String> aProperties) throws org.refcodes.exception.UnmarshalException
      Specified by:
      toUnmarshaled in interface org.refcodes.factory.UnmarshalTypeFactory<org.refcodes.struct.CanonicalMap.CanonicalMapBuilder,​String>
      Throws:
      org.refcodes.exception.UnmarshalException

    • toMarshaled

      default String toMarshaled​(org.refcodes.struct.CanonicalMap aDataStructure, Map<String,​String> aProperties) throws org.refcodes.exception.MarshalException
      Specified by:
      toMarshaled in interface org.refcodes.factory.MarshalTypeFactory<org.refcodes.struct.CanonicalMap,​String>
      Throws:
      org.refcodes.exception.MarshalException

    • toMarshaled

      default String toMarshaled​(org.refcodes.struct.CanonicalMap aDataStructure) throws org.refcodes.exception.MarshalException
      Specified by:
      toMarshaled in interface org.refcodes.factory.MarshalTypeFactory<org.refcodes.struct.CanonicalMap,​String>
      Throws:
      org.refcodes.exception.MarshalException