EncodingCharacters (HAPI - Java HL7 API

java.lang.Object
- ca.uhn.hl7v2.parser.EncodingCharacters

All Implemented Interfaces:

Cloneable
```
public class EncodingCharacters
extends Object
implements Cloneable
```
Represents the set of special characters used to encode traditionally encoded HL7 messages.

Author:

Bryan Tripp (bryan_tripp@sourceforge.net)

Constructor Summary

Constructors
Constructor and Description
`EncodingCharacters(char fieldSeparator, char componentSeparator, char repetitionSeparator, char escapeCharacter, char subcomponentSeparator)`
`EncodingCharacters(char fieldSeparator, char componentSeparator, char repetitionSeparator, char escapeCharacter, char subcomponentSeparator, char truncationCharacter)`
`EncodingCharacters(char fieldSeparator, String encodingCharacters)` Creates new EncodingCharacters object with the given character values.
`EncodingCharacters(EncodingCharacters other)` copies contents of "other"

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`static EncodingCharacters`	`defaultInstance()` Returns an instance of encoding characters with the standard ER7 encoding characters defined: \|^~\&
`boolean`	`equals(Object o)`
`char`	`getComponentSeparator()` Returns the component separator.
`char`	`getEscapeCharacter()` Returns the escape character.
`char`	`getFieldSeparator()` Returns the field separator.
`static EncodingCharacters`	`getInstance(Message message)` Returns an instance using the MSH-1 and MSH-2 values of the given message
`char`	`getRepetitionSeparator()` Returns the repetition separator.
`char`	`getSubcomponentSeparator()` Returns the subcomponent separator.
`char`	`getTruncationCharacter()` Returns the truncation character.
`int`	`hashCode()`
`void`	`setComponentSeparator(char newComponentSep)`
`void`	`setEscapeCharacter(char newEscapeChar)`
`void`	`setFieldSeparator(char newFieldSep)`
`void`	`setRepetitionSeparator(char newRepetitionSep)`
`void`	`setSubcomponentSeparator(char newSubcomponentSep)`
`void`	`setTruncationCharacter(char newTruncationChar)`
`String`	`toString()` Returns the encoding characters (not including field separator) as a string.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EncodingCharacters
```
public EncodingCharacters(char fieldSeparator,
                          String encodingCharacters)
```
    Creates new EncodingCharacters object with the given character values. If the encodingCharacters argument is null, the default values are used.
    
    Parameters:
    
    fieldSeparator - field seperator
    
    encodingCharacters - consists of the characters that appear in MSH-2 (see section 2.8 of the HL7 spec). The characters are Component Separator, Repetition Separator, Escape Character, Subcomponent Separator, and, as of v2.7, the Truncation Character (in that order).
  - EncodingCharacters
```
public EncodingCharacters(char fieldSeparator,
                          char componentSeparator,
                          char repetitionSeparator,
                          char escapeCharacter,
                          char subcomponentSeparator)
```
  - EncodingCharacters
```
public EncodingCharacters(char fieldSeparator,
                          char componentSeparator,
                          char repetitionSeparator,
                          char escapeCharacter,
                          char subcomponentSeparator,
                          char truncationCharacter)
```
  - EncodingCharacters
```
public EncodingCharacters(EncodingCharacters other)
```
    copies contents of "other"
- Method Detail
  - getInstance
```
public static EncodingCharacters getInstance(Message message)
                                      throws HL7Exception
```
    Returns an instance using the MSH-1 and MSH-2 values of the given message
    
    Parameters:
    
    message - the message
    
    Returns:
    
    the encoding characters for this message
    
    Throws:
    
    HL7Exception - If either MSH-1 or MSH-2 are not populated
    
    Since:
    
    1.0
  - getFieldSeparator
```
public char getFieldSeparator()
```
    Returns the field separator.
    
    Returns:
    
    the field separator
  - getComponentSeparator
```
public char getComponentSeparator()
```
    Returns the component separator.
    
    Returns:
    
    the component separator
  - getRepetitionSeparator
```
public char getRepetitionSeparator()
```
    Returns the repetition separator.
    
    Returns:
    
    the repetition separator
  - getEscapeCharacter
```
public char getEscapeCharacter()
```
    Returns the escape character.
    
    Returns:
    
    the escape character
  - getSubcomponentSeparator
```
public char getSubcomponentSeparator()
```
    Returns the subcomponent separator.
    
    Returns:
    
    the subcomponent separator
  - getTruncationCharacter
```
public char getTruncationCharacter()
```
    Returns the truncation character.
    
    Returns:
    
    the truncation character
  - toString
```
public String toString()
```
    Returns the encoding characters (not including field separator) as a string.
    
    Overrides:
    
    toString in class Object
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - setFieldSeparator
```
public void setFieldSeparator(char newFieldSep)
```
  - setComponentSeparator
```
public void setComponentSeparator(char newComponentSep)
```
  - setRepetitionSeparator
```
public void setRepetitionSeparator(char newRepetitionSep)
```
  - setEscapeCharacter
```
public void setEscapeCharacter(char newEscapeChar)
```
  - setSubcomponentSeparator
```
public void setSubcomponentSeparator(char newSubcomponentSep)
```
  - setTruncationCharacter
```
public void setTruncationCharacter(char newTruncationChar)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - defaultInstance
```
public static EncodingCharacters defaultInstance()
```
    Returns an instance of encoding characters with the standard ER7 encoding characters defined: |^~\&
    
    Returns:
    
    a default instance of encoding characters

Class EncodingCharacters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EncodingCharacters

EncodingCharacters

EncodingCharacters

EncodingCharacters

Method Detail

getInstance

getFieldSeparator

getComponentSeparator

getRepetitionSeparator

getEscapeCharacter

getSubcomponentSeparator

getTruncationCharacter

toString

clone

setFieldSeparator

setComponentSeparator

setRepetitionSeparator

setEscapeCharacter

setSubcomponentSeparator

setTruncationCharacter

equals

hashCode

defaultInstance