org.gedcomx.types

Enum NameType

java.lang.Object

java.lang.Enum<NameType>

org.gedcomx.types.NameType

All Implemented Interfaces:

Serializable, Comparable<NameType>, ControlledVocabulary

public enum NameType
extends Enum<NameType>
implements ControlledVocabulary

Enumeration of standard name types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AdoptiveName Name given at adoption.
AlsoKnownAs "Also known as" name.
BirthName Name given at birth.
DeathName Name used at the time of death.
FormalName A formal name, usually given to distinguish it from a name more commonly used.
MarriedName Name accepted at marriage.
Nickname Nickname.
OTHER
ReligiousName A name given at a religious rite or ceremony.

Method Summary

Modifier and Type	Method and Description
static NameType	fromQNameURI(URI qname) Get the enumeration from the QName.
URI	toQNameURI() Return the QName value for this enum.
static NameType	valueOf(String name) Returns the enum constant of this type with the specified name.
static NameType[]	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

BirthName

public static final NameType BirthName

Name given at birth.

DeathName

public static final NameType DeathName

Name used at the time of death.

MarriedName

public static final NameType MarriedName

Name accepted at marriage.

AlsoKnownAs

public static final NameType AlsoKnownAs

"Also known as" name.

Nickname

public static final NameType Nickname

Nickname.

AdoptiveName

public static final NameType AdoptiveName

Name given at adoption.

FormalName

public static final NameType FormalName

A formal name, usually given to distinguish it from a name more commonly used.

ReligiousName

public static final NameType ReligiousName

A name given at a religious rite or ceremony.

OTHER

public static final NameType OTHER

Method Detail

values

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

Returns:

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

valueOf

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

toQNameURI

public URI toQNameURI()

Return the QName value for this enum.

Specified by:

toQNameURI in interface ControlledVocabulary

Returns:

The QName value for this enum.

fromQNameURI

public static NameType fromQNameURI(URI qname)

Get the enumeration from the QName.

Parameters:

qname - The qname.

Returns:

The enumeration.