org.xwiki.model

Enum EntityType

java.lang.Object

java.lang.Enum<EntityType>

org.xwiki.model.EntityType

All Implemented Interfaces:

Serializable, Comparable<EntityType>

public enum EntityType
extends Enum<EntityType>

Represents a type of entity (ie a Model Object such as a Wiki, a Space, a Document, an Attachment, etc).

Since:

2.2M1

Version:

$Id: 62a7f62fa7f211a32e26ad0c3d915ff57ee41d11 $

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATTACHMENT Represents an Attachment Entity.
BLOCK Represents a structured part of the content of a document or an object property.
CLASS_PROPERTY Represents a class property entity.
DOCUMENT Represents a Document Entity.
OBJECT Represents an Object Entity.
OBJECT_PROPERTY Represents an Object Property Entity.
SPACE Represents a Space Entity.
WIKI Represents a Wiki Entity.

Method Summary

Methods

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

WIKI

public static final EntityType WIKI

Represents a Wiki Entity.

SPACE

public static final EntityType SPACE

Represents a Space Entity.

DOCUMENT

public static final EntityType DOCUMENT

Represents a Document Entity.

ATTACHMENT

public static final EntityType ATTACHMENT

Represents an Attachment Entity.

OBJECT

public static final EntityType OBJECT

Represents an Object Entity.

OBJECT_PROPERTY

public static final EntityType OBJECT_PROPERTY

Represents an Object Property Entity.

CLASS_PROPERTY

public static final EntityType CLASS_PROPERTY

Represents a class property entity.

Since:

3.2M1

BLOCK

public static final EntityType BLOCK

Represents a structured part of the content of a document or an object property.

Since:

6.0M1

Method Detail

values

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

Returns:

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

valueOf

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

getLowerCase

public String getLowerCase()

Returns:

the lower case String version of the enum

Since:

6.2.1