org.compass.core.mapping.osem
Enum ManagedId

java.lang.Object
  extended by java.lang.Enum<ManagedId>
      extended by org.compass.core.mapping.osem.ManagedId
All Implemented Interfaces:
Serializable, Comparable<ManagedId>

public enum ManagedId
extends Enum<ManagedId>

Controls how Compass managed ids will be created.

Author:
kimchy

Enum Constant Summary
AUTO
          The meta-data (resource-property) that will act as the id will be computed automatically.
FALSE
          The class property will not have an internal managed id, the meta-data that will be used as an id will be the first one.
NO
          The class property will not have any internal meta-data id, causing it not to be unmarshalled at all.
NO_STORE
          The class proeprty will not create an internal managed id if all its meta data mappings have store=no.
TRUE
          The class property will always have an internal managed id that will be created.
 
Method Summary
static ManagedId fromString(String managedId)
           
static String toString(ManagedId managedId)
           
static ManagedId valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ManagedId[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

AUTO

public static final ManagedId AUTO
The meta-data (resource-property) that will act as the id will be computed automatically.


TRUE

public static final ManagedId TRUE
The class property will always have an internal managed id that will be created.


FALSE

public static final ManagedId FALSE
The class property will not have an internal managed id, the meta-data that will be used as an id will be the first one.


NO_STORE

public static final ManagedId NO_STORE
The class proeprty will not create an internal managed id if all its meta data mappings have store=no.


NO

public static final ManagedId NO
The class property will not have any internal meta-data id, causing it not to be unmarshalled at all.

Method Detail

values

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

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

valueOf

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

toString

public static String toString(ManagedId managedId)

fromString

public static ManagedId fromString(String managedId)


Copyright (c) 2004-2009 The Compass Project.