Package org.gedcomx.types

Enum FacetType

java.lang.Object

java.lang.Enum<FacetType>

org.gedcomx.types.FacetType

All Implemented Interfaces:

Serializable, Comparable<FacetType>, ControlledVocabulary

public enum FacetType
extends Enum<FacetType>
implements ControlledVocabulary

Enumeration of known facet types.

Author:

Ryan Heaton

Enum Constant Summary

Enum Constants

Enum Constant	Description
City	A city.
Country	A country.
Date	A date.
Gender	A gender.
Name	A name.
OTHER	Custom
Page	A page.
Parish	A parish
Place	A place.
Province	A province.
State	A (geographic) state.
Township	A township.
Volume	A volume.
Year	A year.

Method Summary

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

Year

public static final FacetType Year

A year.

State

public static final FacetType State

A (geographic) state.

Province

public static final FacetType Province

A province.

Country

public static final FacetType Country

A country.

City

public static final FacetType City

A city.

Parish

public static final FacetType Parish

A parish

Township

public static final FacetType Township

A township.

Page

public static final FacetType Page

A page.

Volume

public static final FacetType Volume

A volume.

Date

public static final FacetType Date

A date.

Place

public static final FacetType Place

A place.

Name

public static final FacetType Name

A name.

Gender

public static final FacetType Gender

A gender.

OTHER

public static final FacetType OTHER

Custom

Method Detail

values

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

Returns:

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

valueOf

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

Get the enumeration from the QName.

Parameters:

qname - The qname.

Returns:

The enumeration.