org.apache.isis.core.metamodel.facetapi

Enum FeatureType

java.lang.Object

java.lang.Enum<FeatureType>

org.apache.isis.core.metamodel.facetapi.FeatureType

All Implemented Interfaces:

Serializable, Comparable<FeatureType>

public enum FeatureType
extends Enum<FeatureType>

Enumerates the features that a particular Facet can be applied to.

The class-level feature processing is typically performed by FacetFactorys pertaining to OBJECT, performed before the processing of class members. However, FacetFactorys can also be associated with OBJECT_POST_PROCESSING, which is run after all members have been introspected. This is useful for facets (eg the JDO Version annotation) that references class members.

TODO: should rationalize this and ObjectSpecification#getResultType() . Note though that we don't distinguish value properties and reference properties (and we probably shouldn't in ObjectSpecification, either).

Property Summary

Properties

Type	Property and Description
boolean	is

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTION
ACTION_PARAMETER
COLLECTION
OBJECT
OBJECT_POST_PROCESSING
PROPERTY

Field Summary

Fields

Modifier and Type	Field and Description
static List<FeatureType>	ACTIONS_ONLY
static List<FeatureType>	COLLECTIONS_ONLY
static List<FeatureType>	EVERYTHING Use of this is discouraged; instead use multiple FacetFactorys for different features.
static List<FeatureType>	EVERYTHING_BUT_PARAMETERS Use of this is discouraged; instead use multiple FacetFactorys for different features.
static List<FeatureType>	MEMBERS
static List<FeatureType>	OBJECTS_AND_ACTIONS
static List<FeatureType>	OBJECTS_AND_COLLECTIONS
static List<FeatureType>	OBJECTS_AND_PROPERTIES
static List<FeatureType>	OBJECTS_ONLY
static List<FeatureType>	OBJECTS_POST_PROCESSING_ONLY
static List<FeatureType>	OBJECTS_PROPERTIES_AND_COLLECTIONS
static List<FeatureType>	PARAMETERS_ONLY
static List<FeatureType>	PROPERTIES_ONLY

Method Summary

Methods

Modifier and Type	Method and Description
abstract org.apache.isis.applib.Identifier	identifierFor(Class<?> type, Method method)
boolean	isAction()
boolean	isActionParameter()
boolean	isCollection()
boolean	isProperty()
boolean	isPropertyOrCollection() Convenience.
String	toString()
static FeatureType	valueOf(String name) Returns the enum constant of this type with the specified name.
static FeatureType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OBJECT

public static final FeatureType OBJECT

PROPERTY

public static final FeatureType PROPERTY

COLLECTION

public static final FeatureType COLLECTION

ACTION

public static final FeatureType ACTION

ACTION_PARAMETER

public static final FeatureType ACTION_PARAMETER

OBJECT_POST_PROCESSING

public static final FeatureType OBJECT_POST_PROCESSING

Property Detail

is

Field Detail

COLLECTIONS_ONLY

public static final List<FeatureType> COLLECTIONS_ONLY

ACTIONS_ONLY

public static final List<FeatureType> ACTIONS_ONLY

PARAMETERS_ONLY

public static final List<FeatureType> PARAMETERS_ONLY

PROPERTIES_ONLY

public static final List<FeatureType> PROPERTIES_ONLY

OBJECTS_ONLY

public static final List<FeatureType> OBJECTS_ONLY

MEMBERS

public static final List<FeatureType> MEMBERS

OBJECTS_AND_PROPERTIES

public static final List<FeatureType> OBJECTS_AND_PROPERTIES

OBJECTS_AND_COLLECTIONS

public static final List<FeatureType> OBJECTS_AND_COLLECTIONS

OBJECTS_AND_ACTIONS

public static final List<FeatureType> OBJECTS_AND_ACTIONS

OBJECTS_PROPERTIES_AND_COLLECTIONS

public static final List<FeatureType> OBJECTS_PROPERTIES_AND_COLLECTIONS

OBJECTS_POST_PROCESSING_ONLY

public static final List<FeatureType> OBJECTS_POST_PROCESSING_ONLY

EVERYTHING_BUT_PARAMETERS

public static final List<FeatureType> EVERYTHING_BUT_PARAMETERS

Use of this is discouraged; instead use multiple FacetFactorys for different features.

EVERYTHING

public static final List<FeatureType> EVERYTHING

Use of this is discouraged; instead use multiple FacetFactorys for different features.

Method Detail

values

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

Returns:

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

valueOf

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

isProperty

public boolean isProperty()

isCollection

public boolean isCollection()

isAction

public boolean isAction()

isActionParameter

public boolean isActionParameter()

isPropertyOrCollection

public boolean isPropertyOrCollection()

Convenience.

identifierFor

public abstract org.apache.isis.applib.Identifier identifierFor(Class<?> type,
                                              Method method)

toString

public String toString()

Overrides:

toString in class Enum<FeatureType>