eu.etaxonomy.cdm.strategy
Enum TagEnum

java.lang.Object
  java.lang.Enum<TagEnum>
      eu.etaxonomy.cdm.strategy.TagEnum

All Implemented Interfaces:

Serializable, Comparable<TagEnum>

public enum TagEnum
extends Enum<TagEnum>

Tags for atomised taxon name strings and atomised reference citation strings. Used by TaggedText.

Version:

1.0

Author:

a.kohlbecker

Enum Constant Summary

appendedPhrase
Non-atomised addition to a taxon name not ruled by a nomenclatural code

authors
The authors of a reference, also used in taxon names

microreference
Volume, page number etc.

name
A taxon name including genus name, epithet etc.

rank
A name rank abbreviation, e.g.

reference
a reference

year
publication year of a reference

Method Summary

static TagEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static TagEnum[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

name

public static final TagEnum name

A taxon name including genus name, epithet etc.

rank

public static final TagEnum rank

A name rank abbreviation, e.g. subsp.

appendedPhrase

public static final TagEnum appendedPhrase

Non-atomised addition to a taxon name not ruled by a nomenclatural code

authors

public static final TagEnum authors

The authors of a reference, also used in taxon names

reference

public static final TagEnum reference

a reference

microreference

public static final TagEnum microreference

Volume, page number etc. of a reference

year

public static final TagEnum year

publication year of a reference

Method Detail

values

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

Returns:

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

valueOf

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