au.gov.nehta.vendorlibrary.mdm.datatypes

Class XPN

java.lang.Object

au.gov.nehta.vendorlibrary.mdm.datatypes.XPN

public final class XPN
extends Object

XPN Encapsulates an MDM extended person name XPN.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPN.Builder XPN.Builder Build class used to construct and validate an XPN object.

Method Summary

Modifier and Type	Method and Description
String	getFamilyName() Retrieve family name.
String	getGivenName() Retrieve given name.
String	getMiddleInitialOrName() Retrieve middle initial or name.
String	getPrefix() Retrieve prefix.
String	getSuffix() Retrieve suffix.
static XPN	parse(String value) Parse XPN from string.
String	toString() Outputs an XPN in the following format: familyName^givenName^middleInitialOrName^suffix^prefix Variables that are not set are denoted by an empty string.

Methods inherited from class java.lang.Object

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

Method Detail

getFamilyName

public String getFamilyName()

Retrieve family name.

Returns:

Family name.

getGivenName

public String getGivenName()

Retrieve given name.

Returns:

Given name.

getMiddleInitialOrName

public String getMiddleInitialOrName()

Retrieve middle initial or name.

Returns:

Middle initial or name.

getSuffix

public String getSuffix()

Retrieve suffix.

Returns:

Suffix.

getPrefix

public String getPrefix()

Retrieve prefix.

Returns:

Prefix.

toString

public String toString()

Outputs an XPN in the following format:

familyName^givenName^middleInitialOrName^suffix^prefix

Variables that are not set are denoted by an empty string.

Trailing '^' symbols are trimmed. For example:

'familyName^^^^' becomes 'familyName'

Overrides:

toString in class Object

Returns:

Formatted string.

parse

public static XPN parse(String value)

Parse XPN from string.

Parameters:

value - String to be parsed (not null).

Returns:

XPN