Package io.meeds.social.space.constant

Enum Class UserSpacesScope

java.lang.Object

java.lang.Enum<UserSpacesScope>

io.meeds.social.space.constant.UserSpacesScope

All Implemented Interfaces:

Serializable, Comparable<UserSpacesScope>, Constable

public enum UserSpacesScope
extends Enum<UserSpacesScope>

Scope of a profile owner's spaces listing, as requested by a viewer.

This is a client input: it can only ever narrow what is returned. The Service layer forces COMMON for an external viewer, whatever was requested.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Every space where the profile owner has the member role, minus the hidden ones the viewer is not a member of.
COMMON	Only the spaces where both the viewer and the profile owner have the member role.

Method Summary

Modifier and Type	Method	Description
static UserSpacesScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UserSpacesScope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COMMON

public static final UserSpacesScope COMMON

Only the spaces where both the viewer and the profile owner have the member role.

ALL

public static final UserSpacesScope ALL

Every space where the profile owner has the member role, minus the hidden ones the viewer is not a member of.

Method Details

values

public static UserSpacesScope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static UserSpacesScope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null