Interface CanonicalMapFactory

  • All Superinterfaces:
    org.refcodes.factory.MarshalTypeFactory<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.io.InputStream>, org.refcodes.factory.MarshalTypeFactory.MarshalTypeFactoryComplement<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.io.InputStream>, org.refcodes.factory.MarshalTypeFactory.MarshalTypeFactoryComposite<org.refcodes.structure.CanonicalMap,java.io.InputStream,java.lang.String>, org.refcodes.factory.UnmarshalTypeFactory<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.io.InputStream>, org.refcodes.factory.UnmarshalTypeFactory.UnmarshalTypeFactoryComplement<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.io.InputStream>, org.refcodes.factory.UnmarshalTypeFactory.UnmarshalTypeFactoryComposite<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.io.InputStream,java.lang.String>
    All Known Implementing Classes:
    AbstractCanonicalMapFactory, JavaCanonicalMapFactory, JsonCanonicalMapFactory, TomlCanonicalMapFactory, XmlCanonicalMapFactory, YamlCanonicalMapFactory


    public interface CanonicalMapFactory
    extends org.refcodes.factory.UnmarshalTypeFactory.UnmarshalTypeFactoryComposite<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.io.InputStream,java.lang.String>, org.refcodes.factory.MarshalTypeFactory.MarshalTypeFactoryComposite<org.refcodes.structure.CanonicalMap,java.io.InputStream,java.lang.String>
    The CanonicalMapFactory creates data structures from an external representation and creates a external representations from given data structures according to the actual implementation.
    • 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

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default org.refcodes.structure.CanonicalMap.CanonicalMapBuilder fromMarshaled​(java.lang.String aExternalRepresentation)
      default org.refcodes.structure.CanonicalMap.CanonicalMapBuilder fromMarshaled​(java.lang.String aExternalRepresentation, java.util.Map<java.lang.String,java.lang.String> aProperties)
      default java.lang.String fromUnmarshaled​(org.refcodes.structure.CanonicalMap aDataStructure)
      default java.lang.String fromUnmarshaled​(org.refcodes.structure.CanonicalMap aDataStructure, java.util.Map<java.lang.String,java.lang.String> aProperties)
      • Methods inherited from interface org.refcodes.factory.MarshalTypeFactory

        toMarshaled, toMarshaled
      • Methods inherited from interface org.refcodes.factory.UnmarshalTypeFactory

        toUnmarshaled, toUnmarshaled
    • Field Detail

      • COMMENT_PROPERTY

        static final java.lang.String COMMENT_PROPERTY
        Denoting a property specifying a comment.
        See Also:
        Constant Field Values
      • SUPPORTED_DELIMITERS_PROPERTY

        static final java.lang.String SUPPORTED_DELIMITERS_PROPERTY
        Denoting a property specifying the valid delimiter characters all put in a String.
        See Also:
        Constant Field Values
      • DELIMITER_PROPERTY

        static final java.lang.String DELIMITER_PROPERTY
        Denoting a property specifying the valid delimiter characters all put in a String.
        See Also:
        Constant Field Values
    • Method Detail

      • fromMarshaled

        default org.refcodes.structure.CanonicalMap.CanonicalMapBuilder fromMarshaled​(java.lang.String aExternalRepresentation)
                                                                               throws org.refcodes.exception.UnmarshalException
        Specified by:
        fromMarshaled in interface org.refcodes.factory.UnmarshalTypeFactory.UnmarshalTypeFactoryComplement<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.io.InputStream>
        Throws:
        org.refcodes.exception.UnmarshalException
      • fromMarshaled

        default org.refcodes.structure.CanonicalMap.CanonicalMapBuilder fromMarshaled​(java.lang.String aExternalRepresentation,
                                                                                      java.util.Map<java.lang.String,java.lang.String> aProperties)
                                                                               throws org.refcodes.exception.UnmarshalException
        Specified by:
        fromMarshaled in interface org.refcodes.factory.UnmarshalTypeFactory.UnmarshalTypeFactoryComplement<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.io.InputStream>
        Throws:
        org.refcodes.exception.UnmarshalException
      • fromUnmarshaled

        default java.lang.String fromUnmarshaled​(org.refcodes.structure.CanonicalMap aDataStructure,
                                                 java.util.Map<java.lang.String,java.lang.String> aProperties)
                                          throws org.refcodes.exception.MarshalException
        Specified by:
        fromUnmarshaled in interface org.refcodes.factory.MarshalTypeFactory.MarshalTypeFactoryComplement<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.io.InputStream>
        Throws:
        org.refcodes.exception.MarshalException
      • fromUnmarshaled

        default java.lang.String fromUnmarshaled​(org.refcodes.structure.CanonicalMap aDataStructure)
                                          throws org.refcodes.exception.MarshalException
        Specified by:
        fromUnmarshaled in interface org.refcodes.factory.MarshalTypeFactory.MarshalTypeFactoryComplement<org.refcodes.structure.CanonicalMap.CanonicalMapBuilder,java.io.InputStream>
        Throws:
        org.refcodes.exception.MarshalException