Cumulus4j API
(1.0.0)

org.cumulus4j.store.model
Enum FieldMetaRole

java.lang.Object
  extended by java.lang.Enum<FieldMetaRole>
      extended by org.cumulus4j.store.model.FieldMetaRole
All Implemented Interfaces:
Serializable, Comparable<FieldMetaRole>

public enum FieldMetaRole
extends Enum<FieldMetaRole>

Enum for the role of a FieldMeta.

Author:
Marco หงุ่ยตระกูล-Schulze - marco at nightlabs dot de

Enum Constant Summary
arrayElement
          Sub-field (aka part of a real field) used when the primary field is an array.
collectionElement
          Sub-field (aka part of a real field) used when the primary field is of type Collection (or a sub-type like List, Set etc.).
mapKey
          Sub-field (aka part of a real field) used when the primary field is of type Map and this sub-field is the Map's key.
mapValue
          Sub-field (aka part of a real field) used when the primary field is of type Map and this sub-field is the Map's value.
primary
          Only those FieldMeta instances with this role are registered in ClassMeta directly.
 
Method Summary
static FieldMetaRole valueOf(String name)
          Returns the enum constant of this type with the specified name.
static FieldMetaRole[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

primary

public static final FieldMetaRole primary
Only those FieldMeta instances with this role are registered in ClassMeta directly. All others are registered as sub-FieldMeta.


collectionElement

public static final FieldMetaRole collectionElement
Sub-field (aka part of a real field) used when the primary field is of type Collection (or a sub-type like List, Set etc.).


arrayElement

public static final FieldMetaRole arrayElement
Sub-field (aka part of a real field) used when the primary field is an array.


mapKey

public static final FieldMetaRole mapKey
Sub-field (aka part of a real field) used when the primary field is of type Map and this sub-field is the Map's key.


mapValue

public static final FieldMetaRole mapValue
Sub-field (aka part of a real field) used when the primary field is of type Map and this sub-field is the Map's value.

Method Detail

values

public static FieldMetaRole[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (FieldMetaRole c : FieldMetaRole.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static FieldMetaRole 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

Cumulus4j API
(1.0.0)

Copyright © 2012 NightLabs Consulting GmbH. All Rights Reserved.