com.atlassian.confluence.internal.relations

Enum RelatableEntityTypeEnum

java.lang.Object

java.lang.Enum<RelatableEntityTypeEnum>

com.atlassian.confluence.internal.relations.RelatableEntityTypeEnum

All Implemented Interfaces:

Serializable, Comparable<RelatableEntityTypeEnum>

public enum RelatableEntityTypeEnum
extends Enum<RelatableEntityTypeEnum>

An enum representing the different entity types that may be used in relations.

Since:

5.9

See Also:

RelationEntity, RelatableEntity

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATTACHMENT
BLOG
COMMENT
CUSTOM
DRAFT
PAGE
SPACE
USER

Method Summary

Modifier and Type	Method and Description
static RelatableEntityTypeEnum	getByContentEntityObject(ContentEntityObject object)
Class<? extends com.atlassian.core.bean.EntityObject>	getType()
String	getTypeName()
static RelatableEntityTypeEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static RelatableEntityTypeEnum[]	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

PAGE

public static final RelatableEntityTypeEnum PAGE

COMMENT

public static final RelatableEntityTypeEnum COMMENT

BLOG

public static final RelatableEntityTypeEnum BLOG

ATTACHMENT

public static final RelatableEntityTypeEnum ATTACHMENT

USER

public static final RelatableEntityTypeEnum USER

SPACE

public static final RelatableEntityTypeEnum SPACE

DRAFT

public static final RelatableEntityTypeEnum DRAFT

CUSTOM

public static final RelatableEntityTypeEnum CUSTOM

Method Detail

values

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

Returns:

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

valueOf

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

getType

public Class<? extends com.atlassian.core.bean.EntityObject> getType()

getTypeName

public String getTypeName()

getByContentEntityObject

public static RelatableEntityTypeEnum getByContentEntityObject(ContentEntityObject object)

Parameters:

object - ContentEntityObject

Returns:

the RelatableEntityTypeEnum for the supplied content object. IllegalArgumentException if none found.