org.jasig.portlet.announcements.model

Enum AnnouncementFilterType

java.lang.Object

java.lang.Enum<AnnouncementFilterType>

org.jasig.portlet.announcements.model.AnnouncementFilterType

All Implemented Interfaces:

Serializable, Comparable<AnnouncementFilterType>

public enum AnnouncementFilterType
extends Enum<AnnouncementFilterType>

AnnouncementFilterType class.

Version:

$Id: $Id

Author:

Chris Waymire (chris@waymire.net)

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLACKLIST
WHITELIST

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WHITELIST

public static final AnnouncementFilterType WHITELIST

BLACKLIST

public static final AnnouncementFilterType BLACKLIST

Method Detail

values

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

Returns:

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

valueOf

public static AnnouncementFilterType 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()

Getter for the field key.

Returns:

a String object.

toString

public String toString()

toString.

Overrides:

toString in class Enum<AnnouncementFilterType>

Returns:

a String object.