com.ibm.portal.state.accessors.portlet
Enum TargetType

java.lang.Object
  java.lang.Enum<TargetType>
      com.ibm.portal.state.accessors.portlet.TargetType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TargetType>

public enum TargetType
extends java.lang.Enum<TargetType>

Enumeration to identify targets.
Target types that begin with prefix PORLTET_ only belong to portlets.

Since:

6.1.0

Enum Constant Summary

PORTLET_ACTION
A portlet action target represents an action URL for portlets.

PORTLET_RENDER
A portlet render target represents a render URL for portlets.

PORTLET_RESOURCE
A portlet resource target references a resource.

STATIC_RESOURCE
A static resource target such as an image that is served in the context of navigational state

Method Summary

static TargetType	findByDescription(java.lang.String aDescription) Returns the TargetType whose description is equal to the given one.
java.lang.String	toString()
static TargetType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TargetType[]	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

PORTLET_RESOURCE

public static final TargetType PORTLET_RESOURCE

A portlet resource target references a resource. This is only a valid target type for JSR 286 compliant portlets.

PORTLET_ACTION

public static final TargetType PORTLET_ACTION

A portlet action target represents an action URL for portlets.

PORTLET_RENDER

public static final TargetType PORTLET_RENDER

A portlet render target represents a render URL for portlets.

STATIC_RESOURCE

public static final TargetType STATIC_RESOURCE

A static resource target such as an image that is served in the context of navigational state

Method Detail

values

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

Returns:

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

valueOf

public static TargetType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<TargetType>

findByDescription

public static TargetType findByDescription(java.lang.String aDescription)

Returns the TargetType whose description is equal to the given one. In other words aDescription.equals(TargetType.findByDescription(aDescription).toString()) returns true.

Parameters:

aDescription - The description

Returns:

The appropriate TargetType or null.