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

Enum MarshalParameter

java.lang.Object
java.lang.Enum<MarshalParameter>
org.refcodes.data.MarshalParameter
All Implemented Interfaces:
Serializable, Comparable<MarshalParameter>, java.lang.constant.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.

  • 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.

    • 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 type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static MarshalParameter valueOf​(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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