org.compass.annotations
Enum SupportUnmarshall

java.lang.Object
  extended by java.lang.Enum<SupportUnmarshall>
      extended by org.compass.annotations.SupportUnmarshall
All Implemented Interfaces:
Serializable, Comparable<SupportUnmarshall>

public enum SupportUnmarshall
extends Enum<SupportUnmarshall>

Controls if the Searchable class support un-marshalling (the process of converting the raw resource read from the search engine into a domain model object).

Author:
kimchy

Enum Constant Summary
FALSE
          The searchable class will not support un-marshalling.
NA
          Defaults to Compass global osem setting supportUnmarshall.
TRUE
          The searchable class will support un-marshalling.
 
Method Summary
static SupportUnmarshall valueOf(String name)
          Returns the enum constant of this type with the specified name.
static SupportUnmarshall[] 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

NA

public static final SupportUnmarshall NA
Defaults to Compass global osem setting supportUnmarshall. See CompassEnvironment.Osem.SUPPORT_UNMARSHALL.


TRUE

public static final SupportUnmarshall TRUE
The searchable class will support un-marshalling. Will override anything set in Compass global osem setting supportUnmarshall.


FALSE

public static final SupportUnmarshall FALSE
The searchable class will not support un-marshalling. Will override anything set in Compass global osem setting supportUnmarshall.

Method Detail

values

public static final SupportUnmarshall[] 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(SupportUnmarshall c : SupportUnmarshall.values())
        System.out.println(c);

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

valueOf

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


Copyright (c) 2004-2009 The Compass Project.