VerticalBarParser.Delimiters (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.elementmodel.VerticalBarParser.Delimiters

Enclosing class:

VerticalBarParser
```
public class VerticalBarParser.Delimiters
extends Object
```
Delimiters for a message. Note that the application rarely needs to concern itself with this information; it mainly exists for internal use. However if a message is being written to a spec that calls for non-standard delimiters, the application can set them here.

Author:

Grahame

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`DEFAULT_CHARACTER_ESCAPE` Hl7 defined default delimiter for an escape
`static char`	`DEFAULT_DELIMITER_COMPONENT` Hl7 defined default delimiter for a component
`static char`	`DEFAULT_DELIMITER_FIELD` Hl7 defined default delimiter for a field
`static char`	`DEFAULT_DELIMITER_REPETITION` Hl7 defined default delimiter for a repeat
`static char`	`DEFAULT_DELIMITER_SUBCOMPONENT` Hl7 defined default delimiter for a subcomponent

Constructor Summary

Constructors
Constructor and Description

Delimiters()
create

Constructors
Constructor and Description
`Delimiters()` create

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check()` check that the delimiters are valid
`String`	`forMSH2()` build the MSH-2 content
`char`	`getComponentDelimiter()` get defined component character for this message
`char`	`getDelimiterEscapeChar(char ch)` get escape for ch in an escape
`String`	`getEscape(char ch)` get the escape for a character
`char`	`getEscapeCharacter()` get defined escape character for this message
`char`	`getFieldDelimiter()` get defined field character for this message
`char`	`getRepetitionDelimiter()` get repeat field character for this message
`char`	`getSubComponentDelimiter()` get sub-component field character for this message
`boolean`	`isCellDelimiter(char ch)` check to see whether ch is a cell delimiter char (vertical bar parser support)
`boolean`	`isDelimiter(char ch)` check to see whether ch is a delimiter character (vertical bar parser support)
`boolean`	`isDelimiterEscape(char ch)` check to see whether ch represents a delimiter escape
`boolean`	`matches(VerticalBarParser.Delimiters other)`
`void`	`reset()` reset to default HL7 values
`void`	`setComponentDelimiter(char componentDelimiter)` set defined component character for this message
`void`	`setEscapeCharacter(char escapeCharacter)` set defined escape character for this message
`void`	`setFieldDelimiter(char fieldDelimiter)` set defined field character for this message
`void`	`setRepetitionDelimiter(char repetitionDelimiter)` set repeat field character for this message
`void`	`setSubComponentDelimiter(char subComponentDelimiter)` set sub-component field character for this message

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_DELIMITER_FIELD
```
public static final char DEFAULT_DELIMITER_FIELD
```
    Hl7 defined default delimiter for a field
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DELIMITER_COMPONENT
```
public static final char DEFAULT_DELIMITER_COMPONENT
```
    Hl7 defined default delimiter for a component
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DELIMITER_SUBCOMPONENT
```
public static final char DEFAULT_DELIMITER_SUBCOMPONENT
```
    Hl7 defined default delimiter for a subcomponent
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DELIMITER_REPETITION
```
public static final char DEFAULT_DELIMITER_REPETITION
```
    Hl7 defined default delimiter for a repeat
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CHARACTER_ESCAPE
```
public static final char DEFAULT_CHARACTER_ESCAPE
```
    Hl7 defined default delimiter for an escape
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Delimiters
```
public Delimiters()
```
    create
- Method Detail
  - matches
```
public boolean matches(VerticalBarParser.Delimiters other)
```
  - getComponentDelimiter
```
public char getComponentDelimiter()
```
    get defined component character for this message
    
    Returns:
  - setComponentDelimiter
```
public void setComponentDelimiter(char componentDelimiter)
```
    set defined component character for this message
    
    Parameters:
    
    componentDelimiter -
  - getEscapeCharacter
```
public char getEscapeCharacter()
```
    get defined escape character for this message
    
    Returns:
  - setEscapeCharacter
```
public void setEscapeCharacter(char escapeCharacter)
```
    set defined escape character for this message
    
    Parameters:
    
    escapeCharacter -
  - getFieldDelimiter
```
public char getFieldDelimiter()
```
    get defined field character for this message
    
    Returns:
  - setFieldDelimiter
```
public void setFieldDelimiter(char fieldDelimiter)
```
    set defined field character for this message
    
    Parameters:
    
    fieldDelimiter -
  - getRepetitionDelimiter
```
public char getRepetitionDelimiter()
```
    get repeat field character for this message
    
    Returns:
  - setRepetitionDelimiter
```
public void setRepetitionDelimiter(char repetitionDelimiter)
```
    set repeat field character for this message
    
    Parameters:
    
    repetitionDelimiter -
  - getSubComponentDelimiter
```
public char getSubComponentDelimiter()
```
    get sub-component field character for this message
    
    Returns:
  - setSubComponentDelimiter
```
public void setSubComponentDelimiter(char subComponentDelimiter)
```
    set sub-component field character for this message
    
    Parameters:
    
    subComponentDelimiter -
  - reset
```
public void reset()
```
    reset to default HL7 values
  - check
```
public void check()
           throws org.hl7.fhir.exceptions.FHIRException
```
    check that the delimiters are valid
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - isDelimiter
```
public boolean isDelimiter(char ch)
```
    check to see whether ch is a delimiter character (vertical bar parser support)
    
    Parameters:
    
    ch -
    
    Returns:
  - isCellDelimiter
```
public boolean isCellDelimiter(char ch)
```
    check to see whether ch is a cell delimiter char (vertical bar parser support)
    
    Parameters:
    
    ch -
    
    Returns:
  - getEscape
```
public String getEscape(char ch)
```
    get the escape for a character
    
    Parameters:
    
    ch -
    
    Returns:
  - forMSH2
```
public String forMSH2()
```
    build the MSH-2 content
    
    Returns:
  - isDelimiterEscape
```
public boolean isDelimiterEscape(char ch)
```
    check to see whether ch represents a delimiter escape
    
    Parameters:
    
    ch -
    
    Returns:
  - getDelimiterEscapeChar
```
public char getDelimiterEscapeChar(char ch)
                            throws org.hl7.fhir.exceptions.DefinitionException
```
    get escape for ch in an escape
    
    Parameters:
    
    ch -
    
    Returns:
    
    Throws:
    
    org.hl7.fhir.exceptions.DefinitionException
    
    org.hl7.fhir.exceptions.FHIRException

Class VerticalBarParser.Delimiters

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DELIMITER_FIELD

DEFAULT_DELIMITER_COMPONENT

DEFAULT_DELIMITER_SUBCOMPONENT

DEFAULT_DELIMITER_REPETITION

DEFAULT_CHARACTER_ESCAPE

Constructor Detail

Delimiters

Method Detail

matches

getComponentDelimiter

setComponentDelimiter

getEscapeCharacter

setEscapeCharacter

getFieldDelimiter

setFieldDelimiter

getRepetitionDelimiter

setRepetitionDelimiter

getSubComponentDelimiter

setSubComponentDelimiter

reset

check

isDelimiter

isCellDelimiter

getEscape

forMSH2

isDelimiterEscape

getDelimiterEscapeChar