Package org.jivesoftware.openfire.group

Enum SharedGroupVisibility

java.lang.Object

java.lang.Enum<SharedGroupVisibility>

org.jivesoftware.openfire.group.SharedGroupVisibility

All Implemented Interfaces:

Serializable, Comparable<SharedGroupVisibility>

public enum SharedGroupVisibility
extends Enum<SharedGroupVisibility>

Describes with which users a group is shared as a group on their roster.

Author:

Guus der Kinderen, guus.der.kinderen@gmail.com

Enum Constant Summary

Enum Constants

Enum Constant	Description
everybody	Users of this group are shared with all other users in Openfire.
nobody	Users of this group are not shared with anyone.
usersOfGroups	Defines a collection of group names (one or more).

Method Summary

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

nobody

public static final SharedGroupVisibility nobody

Users of this group are not shared with anyone.

everybody

public static final SharedGroupVisibility everybody

Users of this group are shared with all other users in Openfire.

usersOfGroups

public static final SharedGroupVisibility usersOfGroups

Defines a collection of group names (one or more). Users in those groups will be able to see the users in the group for which this visibility is defined. Note that this value is used for both the 'Users of the same group' and 'the following groups' UI setting.

Method Detail

values

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

Returns:

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

valueOf

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

getDbValue

@Nonnull
public String getDbValue()

fromDatabaseValue

@Nonnull
public static SharedGroupVisibility fromDatabaseValue(@Nullable
                                                      String dbValue)