Package google.registry.model.tld.label

Enum Class ReservationType

java.lang.Object

java.lang.Enum<ReservationType>

google.registry.model.tld.label.ReservationType

All Implemented Interfaces:

Serializable, Comparable<ReservationType>, Constable

public enum ReservationType
extends Enum<ReservationType>

Enum describing reservation on a label in a ReservedList.

Note that superusers can override reservations and register a domain no matter what.

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
ALLOWED_IN_SUNRISE	The domain can only be registered during sunrise, and is reserved thereafter.
FULLY_BLOCKED	The domain can never be registered.
NAME_COLLISION	The domain can only be registered during sunrise for defensive purposes, and will never resolve.
RESERVED_FOR_ANCHOR_TENANT	The domain is for an anchor tenant and can only be registered using a specific token.
RESERVED_FOR_SPECIFIC_USE	The domain can only be registered by providing a specific token.

Method Summary

Modifier and Type	Method	Description
String	getMessageForCheck()
static ReservationType	getTypeOfHighestSeverity(Set<ReservationType> types)	Returns the ReservationType with the highest severity, used when a label has multiple reservation types and a reservation message is needed.
static ReservationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ReservationType[]	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

ALLOWED_IN_SUNRISE

public static final ReservationType ALLOWED_IN_SUNRISE

The domain can only be registered during sunrise, and is reserved thereafter.

RESERVED_FOR_SPECIFIC_USE

public static final ReservationType RESERVED_FOR_SPECIFIC_USE

The domain can only be registered by providing a specific token.

RESERVED_FOR_ANCHOR_TENANT

public static final ReservationType RESERVED_FOR_ANCHOR_TENANT

The domain is for an anchor tenant and can only be registered using a specific token.

NAME_COLLISION

public static final ReservationType NAME_COLLISION

The domain can only be registered during sunrise for defensive purposes, and will never resolve.

FULLY_BLOCKED

public static final ReservationType FULLY_BLOCKED

The domain can never be registered.

Method Details

values

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

getMessageForCheck

@Nullable
public String getMessageForCheck()

getTypeOfHighestSeverity

public static ReservationType getTypeOfHighestSeverity(Set<ReservationType> types)

Returns the ReservationType with the highest severity, used when a label has multiple reservation types and a reservation message is needed.

Parameters:

types - the set of reservation types that a label is associated with.

Returns:

the reservation type with the highest severity.