Package jakarta.portlet

Enum MimeResponse.Copy

java.lang.Object

java.lang.Enum<MimeResponse.Copy>

jakarta.portlet.MimeResponse.Copy

All Implemented Interfaces:

Serializable, Comparable<MimeResponse.Copy>

Enclosing interface:

MimeResponse

public static enum MimeResponse.Copy
extends Enum<MimeResponse.Copy>

Specifies processing when a URL is created.

Since:

3.0

See Also:

MimeResponse.createActionURL(Copy), MimeResponse.createRenderURL(Copy)

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Specifies that the public and private render parameters set for the current request are be copied to the URL when it is created.
NONE	Specifies that no parameters are to be copied when a URL is created.
PUBLIC	Specifies that only the public render parameters set for the current request are be copied to the URL when it is created.

Method Summary

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

NONE

public static final MimeResponse.Copy NONE

Specifies that no parameters are to be copied when a URL is created.

Since:

3.0

ALL

public static final MimeResponse.Copy ALL

Specifies that the public and private render parameters set for the current request are be copied to the URL when it is created.

Since:

3.0

PUBLIC

public static final MimeResponse.Copy PUBLIC

Specifies that only the public render parameters set for the current request are be copied to the URL when it is created.

Since:

3.0

Method Detail

values

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

Returns:

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

valueOf

public static MimeResponse.Copy 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