org.jasig.portlet.announcements.service

Enum AnnouncementPreferences

java.lang.Object

java.lang.Enum<AnnouncementPreferences>

org.jasig.portlet.announcements.service.AnnouncementPreferences

All Implemented Interfaces:

Serializable, Comparable<AnnouncementPreferences>

public enum AnnouncementPreferences
extends Enum<AnnouncementPreferences>

Author:

Chris Waymire (chris@waymire.net)

Enum Constant Summary

Enum Constants

Enum Constant and Description
FILTER_ITEMS
FILTER_TYPE

Method Summary

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

FILTER_TYPE

public static final AnnouncementPreferences FILTER_TYPE

FILTER_ITEMS

public static final AnnouncementPreferences FILTER_ITEMS

Method Detail

values

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

Returns:

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

valueOf

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

getKey

public String getKey()