com.ibm.workplace.wcm.api.plugin.rendering
Enum RenderingPluginParameter.Required

java.lang.Object
  java.lang.Enum<RenderingPluginParameter.Required>
      com.ibm.workplace.wcm.api.plugin.rendering.RenderingPluginParameter.Required

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RenderingPluginParameter.Required>

Enclosing interface:

RenderingPluginParameter

public static enum RenderingPluginParameter.Required
extends java.lang.Enum<RenderingPluginParameter.Required>

Possible setting for parameter requirement.

Enum Constant Summary

NOT_REQUIRED_HIDE_BY_DEFAULT
Parameter is not required, and should be hidden in the tag by default

NOT_REQUIRED_SHOW_BY_DEFAULT
Parameter is not required, but should be shown in the tag by default

REQUIRED
Parameter is required

Method Summary

static RenderingPluginParameter.Required	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RenderingPluginParameter.Required[]	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

REQUIRED

public static final RenderingPluginParameter.Required REQUIRED

Parameter is required

NOT_REQUIRED_SHOW_BY_DEFAULT

public static final RenderingPluginParameter.Required NOT_REQUIRED_SHOW_BY_DEFAULT

Parameter is not required, but should be shown in the tag by default

NOT_REQUIRED_HIDE_BY_DEFAULT

public static final RenderingPluginParameter.Required NOT_REQUIRED_HIDE_BY_DEFAULT

Parameter is not required, and should be hidden in the tag by default

Method Detail

values

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

Returns:

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

valueOf

public static RenderingPluginParameter.Required 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