org.apache.shindig.gadgets

Enum RenderingContext

java.lang.Object

java.lang.Enum<RenderingContext>

org.apache.shindig.gadgets.RenderingContext

All Implemented Interfaces:

Serializable, Comparable<RenderingContext>

public enum RenderingContext
extends Enum<RenderingContext>

Defines where the gadget is being rendered.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL
CONFIGURED_GADGET
CONTAINER
GADGET
METADATA

Method Summary

Methods

Modifier and Type	Method and Description
static RenderingContext	getDefault()
String	getFeatureBundleTag()
String	getParamValue()
boolean	isConfigurable()
static RenderingContext	valueOf(String name) Returns the enum constant of this type with the specified name.
static RenderingContext	valueOfParam(String param)
static RenderingContext[]	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

GADGET

public static final RenderingContext GADGET

CONFIGURED_GADGET

public static final RenderingContext CONFIGURED_GADGET

CONTAINER

public static final RenderingContext CONTAINER

METADATA

public static final RenderingContext METADATA

ALL

public static final RenderingContext ALL

Method Detail

values

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

Returns:

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

valueOf

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

getFeatureBundleTag

public String getFeatureBundleTag()

isConfigurable

public boolean isConfigurable()

getParamValue

public String getParamValue()

valueOfParam

public static RenderingContext valueOfParam(String param)

getDefault

public static RenderingContext getDefault()