SwiftParser (Prowide Integrator API Reference)

java.lang.Object
- com.prowidesoftware.swift.io.parser.SwiftParser

```
public class SwiftParser
extends Object
```
FIN Parser. This implementation now properly supports all system messages (i.e: messages for MT 0xx) and service messages (for example: ACK).
As part of this, the following is now also accepted:
- Block 4 may be a non-text block (for example: {4:{101:xx}{102:xx}})
- Support for unparsed texts (at message, block and tag levels)
- Support for user defined blocks (for example: {S:{T01:xxx}{T02:yyy}})
This is based in the old SwiftParser2, that is now deprecated.
Author:

www.prowidesoftware.com

Field Summary

Fields
Modifier and Type Field and Description

static String EOL
Helper constant with the content of System.getProperty("line.separator", "\n")

Fields
Modifier and Type	Field and Description
`static String`	`EOL` Helper constant with the content of `System.getProperty("line.separator", "\n")`

Constructor Summary

Constructors
Constructor and Description
`SwiftParser()` default constructor. NOTE: If this constructor is called, setReader must be called to use the parser
`SwiftParser(File messageFile)` Create a parser and feed it with the contents of the given file
`SwiftParser(InputStream is)` Constructor with an input stream for parsing a message
`SwiftParser(Reader r)` Constructor with a reader for parsing a message
`SwiftParser(String message)` Constructor with a String for parsing a message

Method Summary

Methods
Modifier and Type	Method and Description
`protected SwiftBlock4`	`block4Consume(SwiftBlock4 b, String s)` Parses a block 4 from an input string.
`protected SwiftBlock`	`consumeBlock()` Deprecated. use `consumeBlock(UnparsedTextList)` instead of this, `consumeBlock(null)` is acceptable
`protected SwiftBlock`	`consumeBlock(UnparsedTextList unparsedReceiver)` Consume the next block of the message on the reader.
`protected Tag`	`consumeTag(String buffer, String unparsedText)` Process the input as a tag.
`protected String`	`findBlockStart()` read on the reader until a block start character or EOF is reached.
`SwiftParserConfiguration`	`getConfiguration()` Gets the current parse configuration
`List`	`getErrors()` Get a copy of the errors found.
`protected char`	`identifyBlock(String s)` Identify the block to be consumed.
`boolean`	`isLenient()` Deprecated. use `#getConfiguration()#isLenient()` instead
`SwiftMessage`	`message()` Parse a SWIFT message into a data structure
`SwiftMessage`	`parse(String message)` Sets the parameter string as this parser data and returns the parsed object.
`static SwiftBlock1`	`parseBlock1(String s)` Parses a string containing an MT message block 1 content
`static SwiftBlock2`	`parseBlock2(String s)` Parses a string containing an MT message block 2 content.
`static SwiftBlock2Input`	`parseBlock2Input(String s)` Parses a string containing an MT message block 2 input content (outgoing message sent to SWIFT).
`static SwiftBlock2Output`	`parseBlock2Output(String s)` Parses a string containing an MT message block 2 output content (incoming message received from SWIFT).
`static SwiftBlock3`	`parseBlock3(String s)` Parses a string containing an MT message block 3 content
`static SwiftBlock4`	`parseBlock4(String s)` Parses a string containing the text block of an MT message
`static SwiftBlock5`	`parseBlock5(String s)` Parses a string containing an MT message block 5 content
`protected String`	`readUntilBlockEnds()` Reads the buffer until end of block is reached.
`void`	`setConfiguration(SwiftParserConfiguration configuration)` Sets a new parse configuration
`void`	`setData(String data)` sets the input data to the received string.
`void`	`setLenient(boolean lenient)` Deprecated. use `#getConfiguration()#setLenient(boolean)` instead
`void`	`setReader(Reader r)` sets the input reader. NOTE: this resets the internal buffer
`protected SwiftTagListBlock`	`tagListBlockConsume(SwiftTagListBlock b, String s)` consumes a tag list block (i.e: block 3, block 5 or user defined block)
`protected int`	`textTagEndBlock4(String s, int start, boolean isTextBlock)` finds the end of a text tag (i.e: ":TAG:VALUE").

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

- Field Detail
  - EOL
```
public static final String EOL
```
    Helper constant with the content of System.getProperty("line.separator", "\n")
- Constructor Detail
  - SwiftParser
```
public SwiftParser(InputStream is)
```
    Constructor with an input stream for parsing a message
    
    Parameters:
    is - stream to read
  - SwiftParser
```
public SwiftParser(Reader r)
```
    Constructor with a reader for parsing a message
    
    Parameters:
    r - the Reader with the swift message to read
  - SwiftParser
```
public SwiftParser(String message)
```
    Constructor with a String for parsing a message
    
    Parameters:
    message - the String with the swift message to read
  - SwiftParser
```
public SwiftParser()
```
    default constructor.
    NOTE: If this constructor is called, setReader must be called to use the parser
  - SwiftParser
```
public SwiftParser(File messageFile)
            throws IOException
```
    Create a parser and feed it with the contents of the given file
    
    Parameters:
    messageFile - existing, readable file to read
    
    Throws:
    
    IOException - if an error occurs during read
    Since:
    
    7.7
- Method Detail
  - setReader
```
public void setReader(Reader r)
```
    sets the input reader.
    NOTE: this resets the internal buffer
    
    Parameters:
    r - the reader to use
  - setData
```
public void setData(String data)
```
    sets the input data to the received string.
    
    Parameters:
    data - the data to use as input
  - message
```
public SwiftMessage message()
                     throws IOException
```
    Parse a SWIFT message into a data structure
    
    Returns:
    the parsed swift message object
    
    Throws:
    
    IOException
  - parse
```
public SwiftMessage parse(String message)
                   throws IOException
```
    Sets the parameter string as this parser data and returns the parsed object.
    
    Parameters:
    message - the String with the swift message to parse
    
    Returns:
    the parsed swift message object
    
    Throws:
    
    IOException
    Since:
    
    6.0
  - consumeBlock
```
@Deprecated
@ProwideDeprecated(phase3=_2018)
protected SwiftBlock consumeBlock()
                           throws IOException
```
    Deprecated. use consumeBlock(UnparsedTextList) instead of this, consumeBlock(null) is acceptable
    
    Throws:
    
    IOException
  - consumeBlock
```
protected SwiftBlock consumeBlock(UnparsedTextList unparsedReceiver)
                           throws IOException
```
    Consume the next block of the message on the reader. This methods seeks to a block start, then identifies the block and calls the proper method to consume the block type that is coming, not all blocks are parsed in the same manner.
    
    Parameters:
    unparsedReceiver - may be null, the unparsedTextList that will receive the chunks that can not be identified sas part of the message
    
    Returns:
    the next block in the reader or null if none was found (i.e: end of input)
    
    Throws:
    
    IOException - if an error occurred during read
  - tagListBlockConsume
```
protected SwiftTagListBlock tagListBlockConsume(SwiftTagListBlock b,
                                    String s)
                                         throws IOException
```
    consumes a tag list block (i.e: block 3, block 5 or user defined block)
    
    Parameters:
    b - the block to set up tags into
    s - the block data to process
    
    Returns:
    the processed block (the parameter b)
    
    Throws:
    
    IOException
  - block4Consume
```
protected SwiftBlock4 block4Consume(SwiftBlock4 b,
                        String s)
                             throws IOException
```
    Parses a block 4 from an input string. This method supports the two possible formats of a swift block 4:
    - Text mode: this is the common block 4 for categories 1 to 9.
    - Tag mode: this is the same format as for blocks 3 and 5. This format is used by service messages (for example: ACK) and system messages (category 0).
    Parameters:
    b - the block to set up tags into
    s - the block data to process
    
    Returns:
    the processed block (the parameter b)
    
    Throws:
    
    IOException
  - textTagEndBlock4
```
protected int textTagEndBlock4(String s,
                   int start,
                   boolean isTextBlock)
```
    finds the end of a text tag (i.e: ":TAG:VALUE"). This is used to parse block 4.
    The function search the string looking for the occurrence of any of the sequences:
    - "[LBR]:[X]"
    - "[LBR]}"
    - "[LBR]{"
    - "}"
    where "[LBR]" stands for any of: "[CR]", "[LF]" or "[CR][LF]" and "[X]" is any character other than [CR] and [LF].
    Then considers the end of the tag as NOT containing the found sequence.
    NOTE: the condition "-}" cannot happen because the terminating dash is already removed.
    renamed to state clearly that this search is only used in block4Consume
    Parameters:
    s - the FIN input text
    start - the position to start analysis at
    
    Returns:
    the position where the tag ends (excluding the <CR><LF>)
  - consumeTag
```
protected Tag consumeTag(String buffer,
             String unparsedText)
                  throws IOException
```
    Process the input as a tag. That is: split name and value (and possibly unparsed texts).
    The received buffer contains only the pertinent data for the tag (name and value). Trailing [CR][LF] on the text MUST not be present.
    
    Parameters:
    buffer - the buffer containing the tag
    unparsedText - the unparsed text to assign (use null if none is wanted). This single text is fragmented in multiple texts if there are more than one message.
    
    Returns:
    a swift Tag
    
    Throws:
    
    IOException
  - identifyBlock
```
protected char identifyBlock(String s)
```
    Identify the block to be consumed.
    
    Parameters:
    s - the block identifier
    
    Returns:
    the block identifier or a space if the block can not be identified
  - readUntilBlockEnds
```
protected String readUntilBlockEnds()
                             throws IOException
```
    Reads the buffer until end of block is reached. The initial character of the block must be already consumed and the reader has to be ready to consume the first character inside the block
    This method assumes that the starting block character was consumed because that is required in order to identify the start of a block, and call this method which reads until this block ends.
    
    Returns:
    a string with the block contents
    
    Throws:
    
    IOException
  - findBlockStart
```
protected String findBlockStart()
                         throws IOException
```
    read on the reader until a block start character or EOF is reached.
    
    Throws:
    
    IOException - if thrown during read
  - getErrors
```
public List getErrors()
```
    Get a copy of the errors found. users can manipulate this copy without affecting the original.
    
    Returns:
    the list of errors found
  - isLenient
```
@Deprecated
@ProwideDeprecated(phase4=_2018)
public boolean isLenient()
```
    Deprecated. use #getConfiguration()#isLenient() instead
  - setLenient
```
@Deprecated
@ProwideDeprecated(phase4=_2018)
public void setLenient(boolean lenient)
```
    Deprecated. use #getConfiguration()#setLenient(boolean) instead
  - getConfiguration
```
public SwiftParserConfiguration getConfiguration()
```
    Gets the current parse configuration
    
    Since:
    
    7.8
    
    See Also:
    SwiftParserConfiguration
  - setConfiguration
```
public void setConfiguration(SwiftParserConfiguration configuration)
```
    Sets a new parse configuration
    
    Parameters:
    configuration - new configuration
    Since:
    
    7.8
    
    See Also:
    SwiftParserConfiguration
  - parseBlock4
```
public static SwiftBlock4 parseBlock4(String s)
                               throws IOException
```
    Parses a string containing the text block of an MT message
    
    Parameters:
    s - block content starting with "{4:\r\n" and ending with "\r\n-}"
    
    Returns:
    content parsed into a block 4 or an empty block 4 if string cannot be parsed
    
    Throws:
    
    IOException
    Since:
    
    7.8.4
  - parseBlock3
```
public static SwiftBlock3 parseBlock3(String s)
                               throws IOException
```
    Parses a string containing an MT message block 3 content
    
    Parameters:
    s - block content starting with "{3:" and ending with "}"
    
    Returns:
    content parsed into a block 3 or an empty block 3 if string cannot be parsed
    
    Throws:
    
    IOException
    Since:
    
    7.8.6
  - parseBlock5
```
public static SwiftBlock5 parseBlock5(String s)
                               throws IOException
```
    Parses a string containing an MT message block 5 content
    
    Parameters:
    s - block content starting with "{5:" and ending with "}"
    
    Returns:
    content parsed into a block 5 or an empty block 5 if string cannot be parsed
    
    Throws:
    
    IOException
    Since:
    
    7.8.6
  - parseBlock1
```
public static SwiftBlock1 parseBlock1(String s)
                               throws IOException
```
    Parses a string containing an MT message block 1 content
    
    Parameters:
    s - block content starting with "{1:" and ending with "}"
    
    Returns:
    content parsed into a block 1 or an empty block 1 if string cannot be parsed
    
    Throws:
    
    IOException
    Since:
    
    7.8.6
  - parseBlock2
```
public static SwiftBlock2 parseBlock2(String s)
                               throws IOException
```
    Parses a string containing an MT message block 2 content.
    Will return either a SwiftBlock2Input or SwiftBlock2Output depending on the parameter block content.
    
    Parameters:
    s - block content starting with "{2:" and ending with "}"
    
    Returns:
    content parsed into a block 2 or an empty block 2 if string cannot be parsed
    
    Throws:
    
    IOException
    Since:
    
    7.8.6
  - parseBlock2Input
```
public static SwiftBlock2Input parseBlock2Input(String s)
                                         throws IOException
```
    Parses a string containing an MT message block 2 input content (outgoing message sent to SWIFT).
    If you don't know the container message direction, user parseBlock2(String) instead
    
    Parameters:
    s - block content starting with "{2:I" and ending with "}"
    
    Returns:
    content parsed into a block 2 or an empty block 2 if string cannot be parsed
    
    Throws:
    
    IOException
    Since:
    
    7.8.6
  - parseBlock2Output
```
public static SwiftBlock2Output parseBlock2Output(String s)
                                           throws IOException
```
    Parses a string containing an MT message block 2 output content (incoming message received from SWIFT).
    If you don't know the container message direction, user parseBlock2(String) instead
    
    Parameters:
    s - block content starting with "{2:O" and ending with "}"
    
    Returns:
    content parsed into a block 2 or an empty block 2 if string cannot be parsed
    
    Throws:
    
    IOException
    Since:
    
    7.8.6

Class SwiftParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EOL

Constructor Detail

SwiftParser

SwiftParser

SwiftParser

SwiftParser

SwiftParser

Method Detail

setReader

setData

message

parse

consumeBlock

consumeBlock

tagListBlockConsume

block4Consume

textTagEndBlock4

consumeTag

identifyBlock

readUntilBlockEnds

findBlockStart

getErrors

isLenient

setLenient

getConfiguration

setConfiguration

parseBlock4

parseBlock3

parseBlock5

parseBlock1

parseBlock2

parseBlock2Input

parseBlock2Output