Package edu.harvard.hul.ois.jhove

Enum Class PropertyArity

java.lang.Object
java.lang.Enum<PropertyArity>
edu.harvard.hul.ois.jhove.PropertyArity
All Implemented Interfaces:
Serializable, Comparable<PropertyArity>, java.lang.constant.Constable
public enum PropertyArity extends Enum<PropertyArity>
This class represents the arity (structure type) of a Property. Applications will not create or modify PropertyArities, but will use one of the predefined PropertyArity instances ARRAY, LIST, MAP, SCALAR, or SET.
See Also:

  • Nested Class Summary

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

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ARRAY
    An Arity corresponding to a Java array.
    LIST
    An Arity corresponding to java.util.List or any of its derived classes.
    MAP
    An Arity corresponding to java.util.Map or any of its derived classes.
    SCALAR
    An Arity corresponding to a simple object, which must be of a type corresponding to one of the instances of PropertyType.
    SET
    An Arity corresponding to java.util.Set or any of its derived classes.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final String
    name
    A String name for the Arity, used for reporting.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    toString()
     
    static PropertyArity
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static PropertyArity[]
    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, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ARRAY

      public static final PropertyArity ARRAY
      An Arity corresponding to a Java array. For the Java types Integer, Boolean, Byte, Character, Double, Float, Long, and Short, a Property with arity ARRAY is an array of primitive Java types rather than Objects (e.g., int rather than Integer).

    • LIST

      public static final PropertyArity LIST
      An Arity corresponding to java.util.List or any of its derived classes.

    • MAP

      public static final PropertyArity MAP
      An Arity corresponding to java.util.Map or any of its derived classes.

    • SCALAR

      public static final PropertyArity SCALAR
      An Arity corresponding to a simple object, which must be of a type corresponding to one of the instances of PropertyType.

    • SET

      public static final PropertyArity SET
      An Arity corresponding to java.util.Set or any of its derived classes.

  • Field Details

    • name

      public final String name
      A String name for the Arity, used for reporting.

  • Method Details

    • values

      public static PropertyArity[] 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 PropertyArity 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

    • toString

      public String toString()
      Overrides:
      toString in class Enum<PropertyArity>