Package org.gedcomx.types

Enum RelationshipType

java.lang.Object

java.lang.Enum<RelationshipType>

org.gedcomx.types.RelationshipType

All Implemented Interfaces:

Serializable, Comparable<RelationshipType>, ControlledVocabulary

public enum RelationshipType
extends Enum<RelationshipType>
implements ControlledVocabulary

Enumeration of standard relationship types.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AncestorDescendant
Couple
EnslavedBy
Godparent
OTHER
ParentChild

Method Summary

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

AncestorDescendant

public static final RelationshipType AncestorDescendant

Couple

public static final RelationshipType Couple

EnslavedBy

public static final RelationshipType EnslavedBy

Godparent

public static final RelationshipType Godparent

ParentChild

public static final RelationshipType ParentChild

OTHER

public static final RelationshipType OTHER

Method Detail

values

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

Returns:

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

valueOf

public static RelationshipType 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 RelationshipType fromQNameURI(URI qname)

Get the enumeration from the QName.

Parameters:

qname - The qname.

Returns:

The enumeration.