Module org.refcodes.data
Package org.refcodes.data

Enum Class MarshalParameter

java.lang.Object
java.lang.Enum<MarshalParameter>
org.refcodes.data.MarshalParameter
All Implemented Interfaces:
Serializable, Comparable<MarshalParameter>, Constable, org.refcodes.mixin.NameAccessor
public enum MarshalParameter extends Enum<MarshalParameter> implements org.refcodes.mixin.NameAccessor
MarshalParameter defines common parameters (parameter is considered the key of a key/value pair) of a given semantics for the according property.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

    Nested classes/interfaces inherited from interface org.refcodes.mixin.NameAccessor

    org.refcodes.mixin.NameAccessor.NameBuilder<B extends org.refcodes.mixin.NameAccessor.NameBuilder<B>>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BASE_URL
    A base URL may be stored in such a property.
    CHARSET
    Identifies a charset code such as Encoding.UTF_8's Encoding.getCode().
    COMMENT
    Identifies a comment String.
    DELIMITER
    The value of such a property identifies a single delimiter char.
    DELIMITERS
    The value of such a property identifies a multiple delimiter chars.
    DOCUMENT_ROOT_PRESERVE
    The value of such a property determines whether unmarshaling (XML) documents will preserve the root element.
    ENCODING
    Identifies the encoding such as Encoding.UTF_8.
    HEADER
    E.g. used in an XML file's head's declaration such as <?
    ROOT_ELEMENT
    The root element to be used when marshaling a structure to a notation which requires a root element.
    STAND_ALONE
    E.g. used in an XML file's head's declaration such as <?
    VERSION
    Identifies a version, such as an XML version (depends on the notation to which to marshal).

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    static MarshalParameter
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static MarshalParameter[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • CHARSET

      public static final MarshalParameter CHARSET
      Identifies a charset code such as Encoding.UTF_8's Encoding.getCode().

    • BASE_URL

      public static final MarshalParameter BASE_URL
      A base URL may be stored in such a property.

    • DELIMITER

      public static final MarshalParameter DELIMITER
      The value of such a property identifies a single delimiter char.

    • DELIMITERS

      public static final MarshalParameter DELIMITERS
      The value of such a property identifies a multiple delimiter chars.

    • DOCUMENT_ROOT_PRESERVE

      public static final MarshalParameter DOCUMENT_ROOT_PRESERVE
      The value of such a property determines whether unmarshaling (XML) documents will preserve the root element. As an (XML) document requires a root element, the root element often is provided merely as of syntactic reasons and must be omitted as of semantic reasons. Unmarshaling functionality therefore by default skips the root elelemt, as this is considered merely to serve as an envelope. This behavior can be overridden by setting this property to true.

    • COMMENT

      public static final MarshalParameter COMMENT
      Identifies a comment String.

    • ENCODING

      public static final MarshalParameter ENCODING
      Identifies the encoding such as Encoding.UTF_8.

    • VERSION

      public static final MarshalParameter VERSION
      Identifies a version, such as an XML version (depends on the notation to which to marshal).

    • ROOT_ELEMENT

      public static final MarshalParameter ROOT_ELEMENT
      The root element to be used when marshaling a structure to a notation which requires a root element.

    • STAND_ALONE

      public static final MarshalParameter STAND_ALONE
      E.g. used in an XML file's head's declaration such as <?xml ecnoding="UTF-8" version="1.0" standalone="yes"?> to determine whether this is a stand alone document (note that it is declared as "standalone"!).

  • Method Details

    • values

      public static MarshalParameter[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static MarshalParameter valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getName

      public String getName()
      Specified by:
      getName in interface org.refcodes.mixin.NameAccessor