com.vaadin.collaborationengine

Enum EntryScope

java.lang.Object

java.lang.Enum<EntryScope>

com.vaadin.collaborationengine.EntryScope

All Implemented Interfaces:

Serializable, Comparable<EntryScope>

public enum EntryScope
extends Enum<EntryScope>

The scope of data in a topic.

Since:

4.0

Author:

Vaadin Ltd

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTION Entries with this scope will be automatically removed once the connection to the topic which created them is deactivated.
TOPIC This is the default scope and entries with this scope will be removed only if explicitly requested.

Method Summary

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

TOPIC

public static final EntryScope TOPIC

This is the default scope and entries with this scope will be removed only if explicitly requested.

CONNECTION

public static final EntryScope CONNECTION

Entries with this scope will be automatically removed once the connection to the topic which created them is deactivated.

Method Detail

values

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

Returns:

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

valueOf

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