org.gatein.portal.controller.resource

Enum ResourceScope

java.lang.Object

java.lang.Enum<ResourceScope>

org.gatein.portal.controller.resource.ResourceScope

All Implemented Interfaces:

Serializable, Comparable<ResourceScope>

public enum ResourceScope
extends Enum<ResourceScope>

Author:

Julien Viet

Enum Constant Summary

Enum Constants

Enum Constant and Description
GROUP
PORTAL
PORTLET
SHARED

Method Summary

Methods

Modifier and Type	Method and Description
ResourceId	create(String name) Returns a new ResourceId scoped with this enum instance.
static ResourceScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResourceScope[]	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

SHARED

public static final ResourceScope SHARED

PORTAL

public static final ResourceScope PORTAL

PORTLET

public static final ResourceScope PORTLET

GROUP

public static final ResourceScope GROUP

Method Detail

values

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

Returns:

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

valueOf

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

create

public ResourceId create(String name)

Returns a new ResourceId scoped with this enum instance.

Parameters:

name - the name to wrap

Returns:

a new resource id