org.xwiki.mentions

Enum MentionLocation

java.lang.Object

java.lang.Enum<MentionLocation>

org.xwiki.mentions.MentionLocation

All Implemented Interfaces:

Serializable, Comparable<MentionLocation>

@Unstable
public enum MentionLocation
extends Enum<MentionLocation>

List the location where mentions can occur.

Since:

12.5RC1

Version:

$Id: a839916d987bac48a88392b35e35445617c13b70 $

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNOTATION In an annotation.
AWM_FIELD In a Application Within Minutes field.
COMMENT In a comment.
DOCUMENT Body of a document.
UNDEFINED When the location of the mention is unknown.

Method Summary

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

DOCUMENT

public static final MentionLocation DOCUMENT

Body of a document.

COMMENT

public static final MentionLocation COMMENT

In a comment.

ANNOTATION

public static final MentionLocation ANNOTATION

In an annotation.

AWM_FIELD

public static final MentionLocation AWM_FIELD

In a Application Within Minutes field.

UNDEFINED

public static final MentionLocation UNDEFINED

When the location of the mention is unknown.

Method Detail

values

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

Returns:

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

valueOf

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