org.sakaiproject.portal.api

Enum SiteView.View

java.lang.Object

java.lang.Enum<SiteView.View>

org.sakaiproject.portal.api.SiteView.View

All Implemented Interfaces:

Serializable, Comparable<SiteView.View>

Enclosing interface:

SiteView

public static enum SiteView.View
extends Enum<SiteView.View>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_SITES_VIEW
CURRENT_SITE_VIEW
DEFAULT_SITE_VIEW
DHTML_MORE_VIEW
SUB_SITES_VIEW

Method Summary

Methods

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

ALL_SITES_VIEW

public static final SiteView.View ALL_SITES_VIEW

DEFAULT_SITE_VIEW

public static final SiteView.View DEFAULT_SITE_VIEW

DHTML_MORE_VIEW

public static final SiteView.View DHTML_MORE_VIEW

SUB_SITES_VIEW

public static final SiteView.View SUB_SITES_VIEW

CURRENT_SITE_VIEW

public static final SiteView.View CURRENT_SITE_VIEW

Method Detail

values

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

Returns:

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

valueOf

public static SiteView.View 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