Package com.broadleafcommerce.paymentgateway.domain.enums

Enum Class PaymentInfoAttributes

java.lang.Object

java.lang.Enum<PaymentInfoAttributes>

com.broadleafcommerce.paymentgateway.domain.enums.PaymentInfoAttributes

All Implemented Interfaces:

Serializable, Comparable<PaymentInfoAttributes>, Constable

public enum PaymentInfoAttributes
extends Enum<PaymentInfoAttributes>
implements Serializable

Common keys used for the PaymentInfo.getAttributes() map

Author:

Chris Kittrell (ckittrell)

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
IP_ADDRESS	The calling user's IP address
USER_AGENT	The calling user's browser user agent

Method Summary

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

IP_ADDRESS

public static final PaymentInfoAttributes IP_ADDRESS

The calling user's IP address

USER_AGENT

public static final PaymentInfoAttributes USER_AGENT

The calling user's browser user agent

Method Details

values

public static PaymentInfoAttributes[] 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 PaymentInfoAttributes 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