Package org.gbif.api.model.common

Enum DoiStatus

java.lang.Object

java.lang.Enum<DoiStatus>

org.gbif.api.model.common.DoiStatus

All Implemented Interfaces:

Serializable, Comparable<DoiStatus>

public enum DoiStatus
extends Enum<DoiStatus>

This enumeration represents the status of a DOI identifier. It represents both EZID and DataCite DOIs.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DELETED	The identifier once was registered, but the object referenced by the identifier is not available.
FAILED	A failed DOI status indicates we could not communicate with DataCite cause we had invalid metadata.
NEW	A NEW DOI status indicates the DOI has been minted in GBIF only and has not yet been passed on to DataCite.
REGISTERED	A public, registered DOI.
RESERVED	The identifier is known only to the DOI registration agency.

Method Summary

Modifier and Type	Method	Description
static DoiStatus	fromString(String status)
String	getEzid()
boolean	isRegistered()
static DoiStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DoiStatus[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEW

public static final DoiStatus NEW

A NEW DOI status indicates the DOI has been minted in GBIF only and has not yet been passed on to DataCite.

RESERVED

public static final DoiStatus RESERVED

The identifier is known only to the DOI registration agency. This status may be used to reserve an identifier name without advertising the identifier's existence to resolvers and other external services. A reserved identifier may be fully deleted.

REGISTERED

public static final DoiStatus REGISTERED

A public, registered DOI. It's target URL is known to public resolvers and other external services. It may be marked as DELETED in the future, but never again as RESERVED.

DELETED

public static final DoiStatus DELETED

The identifier once was registered, but the object referenced by the identifier is not available. This is known as an "inactive" DOI in DataCite and "unavailable" in EZID.
In EZID the identifier redirects to an EZID-provided "tombstone" page regardless of its target URL. In DataCite the original target URL is still available.

FAILED

public static final DoiStatus FAILED

A failed DOI status indicates we could not communicate with DataCite cause we had invalid metadata. This DOI then requires a manual cleanup. The status is GBIF internal only!

Method Detail

values

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

Returns:

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

valueOf

public static DoiStatus 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

getEzid

public String getEzid()

Returns:

the identifier status value used in EZID.

isRegistered

public boolean isRegistered()

Returns:

true if the identifier is registered

fromString

public static DoiStatus fromString(String status)