Package google.registry.model.domain.token

Enum Class AllocationToken.TokenType

java.lang.Object

java.lang.Enum<AllocationToken.TokenType>

google.registry.model.domain.token.AllocationToken.TokenType

All Implemented Interfaces:

Serializable, Comparable<AllocationToken.TokenType>, Constable

Enclosing class:

AllocationToken

public static enum AllocationToken.TokenType
extends Enum<AllocationToken.TokenType>

Type of the token that indicates how and where it should be used.

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
BULK_PRICING	Token used for bulk pricing
DEFAULT_PROMO	Token saved on a TLD to use if no other token is passed from the client
PACKAGE	Deprecated.
REGISTER_BSA	Allows bypassing the BSA check during domain creation, otherwise has the same semantics as SINGLE_USE.
SINGLE_USE	Invalid after use
UNLIMITED_USE	Do not expire after use

Method Summary

Modifier and Type	Method	Description
boolean	isOneTimeUse()	Returns true if token should be invalidated after use.
static AllocationToken.TokenType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AllocationToken.TokenType[]	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

BULK_PRICING

public static final AllocationToken.TokenType BULK_PRICING

Token used for bulk pricing

DEFAULT_PROMO

public static final AllocationToken.TokenType DEFAULT_PROMO

Token saved on a TLD to use if no other token is passed from the client

PACKAGE

@Deprecated
public static final AllocationToken.TokenType PACKAGE

Deprecated.

This is the old name for what is now BULK_PRICING.

SINGLE_USE

public static final AllocationToken.TokenType SINGLE_USE

Invalid after use

UNLIMITED_USE

public static final AllocationToken.TokenType UNLIMITED_USE

Do not expire after use

REGISTER_BSA

public static final AllocationToken.TokenType REGISTER_BSA

Allows bypassing the BSA check during domain creation, otherwise has the same semantics as SINGLE_USE.

This token applies to a single domain only. If the domain is not blocked by BSA at the redemption time this token is processed like SINGLE_USE, as mentioned above.

Method Details

values

public static AllocationToken.TokenType[] 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 AllocationToken.TokenType 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

isOneTimeUse

public boolean isOneTimeUse()

Returns true if token should be invalidated after use.