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

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.mdm.datatypes.XPN

public final class XPN
extends java.lang.Object

XPN Encapsulates an MDM extended person name XPN.


Nested Class Summary
static class XPN.Builder
          XPN.Builder Build class used to construct and validate an XPN object.
 
Method Summary
 java.lang.String getFamilyName()
          Retrieve family name.
 java.lang.String getGivenName()
          Retrieve given name.
 java.lang.String getMiddleInitialOrName()
          Retrieve middle initial or name.
 java.lang.String getPrefix()
          Retrieve prefix.
 java.lang.String getSuffix()
          Retrieve suffix.
static XPN parse(java.lang.String value)
          Parse XPN from string.
 java.lang.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 java.lang.String getFamilyName()
Retrieve family name.

Returns:
Family name.

getGivenName

public java.lang.String getGivenName()
Retrieve given name.

Returns:
Given name.

getMiddleInitialOrName

public java.lang.String getMiddleInitialOrName()
Retrieve middle initial or name.

Returns:
Middle initial or name.

getSuffix

public java.lang.String getSuffix()
Retrieve suffix.

Returns:
Suffix.

getPrefix

public java.lang.String getPrefix()
Retrieve prefix.

Returns:
Prefix.

toString

public java.lang.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 java.lang.Object
Returns:
Formatted string.

parse

public static XPN parse(java.lang.String value)
Parse XPN from string.

Parameters:
value - String to be parsed (not null).
Returns:
XPN