Package com.atlassian.confluence.internal.relations

Enum RelationshipTypeEnum

java.lang.Object

java.lang.Enum<RelationshipTypeEnum>

com.atlassian.confluence.internal.relations.RelationshipTypeEnum

All Implemented Interfaces:

Serializable, Comparable<RelationshipTypeEnum>

public enum RelationshipTypeEnum
extends Enum<RelationshipTypeEnum>

Relationship type helps to understand how to process relations.

Since:

5.9

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTENT2CONTENT
USER2CONTENT
USER2USER

Method Summary

Modifier and Type	Method	Description
static RelationshipTypeEnum	getRelationshipType(RelationDescriptor<?,?> relationDescriptor)	Returns type of relationship based on relation descriptor.
static RelationshipTypeEnum	getRelationshipType(RelationDescriptor<?,?> relationDescriptor, boolean throwOnError)	Returns type of relationship based on relation descriptor.
static RelationshipTypeEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RelationshipTypeEnum[]	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

CONTENT2CONTENT

public static final RelationshipTypeEnum CONTENT2CONTENT

USER2CONTENT

public static final RelationshipTypeEnum USER2CONTENT

USER2USER

public static final RelationshipTypeEnum USER2USER

Method Detail

values

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

Returns:

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

valueOf

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

getRelationshipType

public static RelationshipTypeEnum getRelationshipType(RelationDescriptor<?,?> relationDescriptor)

Returns type of relationship based on relation descriptor.

Parameters:

relationDescriptor -

Returns:

type of relation

See Also:

RelationDescriptor

getRelationshipType

public static RelationshipTypeEnum getRelationshipType(RelationDescriptor<?,?> relationDescriptor,
                                                       boolean throwOnError)

Returns type of relationship based on relation descriptor.

Parameters:

relationDescriptor -

Returns:

type of relation

See Also:

RelationDescriptor