Package com.broadleafcommerce.search.api.type

Enum Class RedirectType

java.lang.Object

java.lang.Enum<RedirectType>

com.broadleafcommerce.search.api.type.RedirectType

All Implemented Interfaces:

Serializable, Comparable<RedirectType>, Constable

public enum RedirectType
extends Enum<RedirectType>

Enumeration of the types of redirects available to configure for search.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PERMANENT
TEMPORARY

Method Summary

Modifier and Type	Method	Description
String	status()	Get the HTTP status associated with the redirect type, to be used when performing the redirect.
static RedirectType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RedirectType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PERMANENT

public static final RedirectType PERMANENT

TEMPORARY

public static final RedirectType TEMPORARY

Method Details

values

public static RedirectType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static RedirectType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

status

public String status()

Get the HTTP status associated with the redirect type, to be used when performing the redirect.

Returns:

HTTP status associated with the redirect type