com.hds.hcpaw.fss.api.model

Enum ShareState

java.lang.Object

java.lang.Enum<ShareState>

com.hds.hcpaw.fss.api.model.ShareState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ShareState>

public enum ShareState
extends java.lang.Enum<ShareState>

the state of a user or group's membership to a shared folder

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORMER_MEMBER The user has left or been kicked out of the share, and cannot currently access it, or the group has been removed
INVITED The user has not yet accepted an invitation to the share, or the group has been invited to the share
MEMBER The user has accepted an invitation to the share, and is currently able to access it.

Method Summary

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

INVITED

public static final ShareState INVITED

The user has not yet accepted an invitation to the share, or the group has been invited to the share

MEMBER

public static final ShareState MEMBER

The user has accepted an invitation to the share, and is currently able to access it. Not currently used for groups

FORMER_MEMBER

public static final ShareState FORMER_MEMBER

The user has left or been kicked out of the share, and cannot currently access it, or the group has been removed

Method Detail

values

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

Returns:

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

valueOf

public static ShareState valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null