org.pageseeder.bridge.model

Enum PSNotify

java.lang.Object

java.lang.Enum<PSNotify>

org.pageseeder.bridge.model.PSNotify

All Implemented Interfaces:

Serializable, Comparable<PSNotify>

public enum PSNotify
extends Enum<PSNotify>

Use for the notify parameter when creating or replying to comments.

Version:

0.3.0

Author:

Christophe Lauret

Enum Constant Summary

Enum Constants

Enum Constant and Description
announce will ignore members' individual notifications settings.
normal Notify based on each member's notification settings.
silent No notification.

Method Summary

Methods

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

normal

public static final PSNotify normal

Notify based on each member's notification settings.

announce

public static final PSNotify announce

will ignore members' individual notifications settings.

silent

public static final PSNotify silent

No notification.

Method Detail

values

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

Returns:

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

valueOf

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

parameter

public String parameter()

Returns:

the parameter to use when communicating with PageSeder