Package org.gedcomx.source

Class CitationField

java.lang.Object

org.gedcomx.source.CitationField

All Implemented Interfaces:

HasJsonKey

public class CitationField
extends Object
implements HasJsonKey

Represents a citation field -- its name and value.

Constructor Summary

Constructors

Constructor	Description
CitationField()
CitationField(String name, String value)
CitationField(URI name, String value)

Method Summary

Modifier and Type	Method	Description
String	getJsonKey()	The json key that is used define this link in a map.
URI	getName()	The citation field's name.
String	getValue()	The citation field's value.
boolean	isHasUniqueKey()
CitationField	name(URI name)	Build out this citation field with a name.
CitationField	nameValue(String name)	Build out this citation field with a name.
void	setJsonKey(String jsonKey)	The json key that is used define this link in a map.
void	setName(URI name)	The citation field's name.
void	setNameValue(String name)	The citation field's name.
void	setValue(String value)	The citation field's value.
CitationField	value(String value)	Build out this citation field with a value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CitationField

public CitationField()

CitationField

public CitationField(URI name,
                     String value)

CitationField

public CitationField(String name,
                     String value)

Method Detail

isHasUniqueKey

public boolean isHasUniqueKey()

Specified by:

isHasUniqueKey in interface HasJsonKey

getName

public URI getName()

The citation field's name.

Returns:

The citation field's name.

setName

public void setName(URI name)

The citation field's name.

Parameters:

name - The citation field's name.

name

public CitationField name(URI name)

Build out this citation field with a name.

Parameters:

name - the name.

Returns:

this.

setNameValue

public void setNameValue(String name)

The citation field's name.

Parameters:

name - The citation field's name.

nameValue

public CitationField nameValue(String name)

Build out this citation field with a name.

Parameters:

name - The name.

Returns:

this.

getJsonKey

public String getJsonKey()

The json key that is used define this link in a map.

Specified by:

getJsonKey in interface HasJsonKey

Returns:

The json key that is used define this link in a map.

setJsonKey

public void setJsonKey(String jsonKey)

The json key that is used define this link in a map.

Specified by:

setJsonKey in interface HasJsonKey

Parameters:

jsonKey - The json key that is used define this link in a map.

getValue

public String getValue()

The citation field's value.

Returns:

The citation field's value.

setValue

public void setValue(String value)

The citation field's value.

Parameters:

value - The citation field's value.

value

public CitationField value(String value)

Build out this citation field with a value.

Parameters:

value - The value.

Returns:

this.