SwiftBlock (Prowide Integrator API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.SwiftBlock

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SwiftTagListBlock, SwiftValueBlock
```
public abstract class SwiftBlock
extends Object
implements Serializable
```
Base class for a generic SWIFT block.
This is an abstract class so specific block classes for each block (block 1, 2, 3, etc...) should be instantiated.

Instances of this class may have a list of unparsed texts (UnparsedTextList). For easy access, methods have been created that first ensure the lists exists (the real object is created and then call the base method).
However, not all the base list methods have been implemented. If you need to use not exposed functionality, retrieve the underlying list with (see getUnparsedTexts method)

Author:

www.prowidesoftware.com

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`blockType` helper for hibernate mapping
`protected Long`	`id` Unique identifier of the swift block.
`protected Boolean`	`input` Only valid for block2, only when using hibernate for persistence
`protected Boolean`	`output` Only valid for block2, only when using hibernate for persistence
`protected UnparsedTextList`	`unparsedTexts` List of unparsed texts.

Constructor Summary

Constructors
Constructor and Description

SwiftBlock()
Default constructor, shouldn't be used normally.

SwiftBlock(UnparsedTextList unparsedText)
Constructor for an unparsed text list

Constructors
Constructor and Description
`SwiftBlock()` Default constructor, shouldn't be used normally.
`SwiftBlock(UnparsedTextList unparsedText)` Constructor for an unparsed text list

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getBlockType()`
`Long`	`getId()` Get the unique identifier of this block or `null` if it is not set
`Boolean`	`getInput()` Deprecated. use `getBlockType()`
`abstract String`	`getName()` Returns the block name (this method is to be overwritten for derived classes).
`abstract Integer`	`getNumber()` Returns the block number (this method is to be overwritten for derived classes).
`Boolean`	`getOutput()` Deprecated. use `getBlockType()`
`UnparsedTextList`	`getUnparsedTexts()` Returns the unparsed text list attached to the Block.
`Integer`	`getUnparsedTextsSize()` returns the size of the unparsed text list
`int`	`hashCode()`
`boolean`	`isTagBlock()` Tell if this block is a block that contains a list of tags (3-5) or is a block with fixed length value (1-2)
`protected abstract void`	`setBlockName(String blockName)` Sets the block name (this method is to be overwrite for derived classes).
`protected abstract void`	`setBlockNumber(Integer blockNumber)` Sets the block number (this method is to be overwrite for derived classes).
`void`	`setBlockType(String blockType)` should not be normally called
`void`	`setId(Long id)` Sets the unique identifier of this block
`void`	`setInput(Boolean input)` Only valid for block2, only when using hibernate for persistence
`void`	`setOutput(Boolean output)` Only valid for block2, only when using hibernate for persistence
`void`	`setUnparsedTexts(UnparsedTextList texts)` sets the list of unparsed texts
`String`	`toString()`
`void`	`unparsedTextAddText(String text)` adds a new unparsed text
`void`	`unparsedTextAddText(SwiftMessage message)` adds a new unparsed text from a message
`SwiftMessage`	`unparsedTextGetAsMessage(Integer index)` get an unparsed text as a parsed swift message
`String`	`unparsedTextGetText(Integer index)` get an unparsed text
`Boolean`	`unparsedTextIsMessage(Integer index)` decides if a specific text (by index) is likely a SWIFT FIN message.
`protected void`	`unparsedTextVerify()` verifies that the unparsed text list exists

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

- Field Detail
  - id
```
protected Long id
```
    Unique identifier of the swift block. Mainly used for persistence services.
  - unparsedTexts
```
protected UnparsedTextList unparsedTexts
```
    List of unparsed texts. For performance reasons, this will be null until really needed.
  - input
```
protected Boolean input
```
    Only valid for block2, only when using hibernate for persistence
  - output
```
protected Boolean output
```
    Only valid for block2, only when using hibernate for persistence
  - blockType
```
protected String blockType
```
    helper for hibernate mapping
- Constructor Detail
  - SwiftBlock
```
public SwiftBlock()
```
    Default constructor, shouldn't be used normally. DO NOT USE: present only for subclasses
  - SwiftBlock
```
public SwiftBlock(UnparsedTextList unparsedText)
```
    Constructor for an unparsed text list
    
    Parameters:
    unparsedText - the list of unparsed texts
- Method Detail
  - getBlockType
```
public String getBlockType()
```
    Returns:
    a string identifying block type or null if not implemented
  - setBlockType
```
public void setBlockType(String blockType)
```
    should not be normally called
    
    Parameters:
    blockType -
  - setBlockNumber
```
protected abstract void setBlockNumber(Integer blockNumber)
```
    Sets the block number (this method is to be overwrite for derived classes).
    
    Parameters:
    blockNumber - the block number to set
    Since:
    
    5.0
  - setBlockName
```
protected abstract void setBlockName(String blockName)
```
    Sets the block name (this method is to be overwrite for derived classes).
    
    Parameters:
    blockName - the block name to set
    Since:
    
    5.0
  - getNumber
```
public abstract Integer getNumber()
```
    Returns the block number (this method is to be overwritten for derived classes).
    
    Returns:
    Integer containing the block's number
  - getName
```
public abstract String getName()
```
    Returns the block name (this method is to be overwritten for derived classes).
    
    Returns:
    block name
    Since:
    
    5.0
  - getId
```
public Long getId()
```
    Get the unique identifier of this block or null if it is not set
    
    Returns:
    the unique identifier
  - setId
```
public void setId(Long id)
```
    Sets the unique identifier of this block
    
    Parameters:
    id - the unique identifier to set.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isTagBlock
```
public boolean isTagBlock()
```
    Tell if this block is a block that contains a list of tags (3-5) or is a block with fixed length value (1-2)
    
    Returns:
    true if this object contains a list of tags (which may be empty or null
  - unparsedTextVerify
```
protected void unparsedTextVerify()
```
    verifies that the unparsed text list exists
  - getUnparsedTexts
```
public UnparsedTextList getUnparsedTexts()
```
    Returns the unparsed text list attached to the Block.
    
    Returns:
    the unparsed texts attached to the block
  - setUnparsedTexts
```
public void setUnparsedTexts(UnparsedTextList texts)
```
    sets the list of unparsed texts
    
    Parameters:
    texts - the new list of unparsed texts (may be null)
  - getUnparsedTextsSize
```
public Integer getUnparsedTextsSize()
```
    returns the size of the unparsed text list
    
    Returns:
    the count of unparsed test attached to the block
  - unparsedTextIsMessage
```
public Boolean unparsedTextIsMessage(Integer index)
```
    decides if a specific text (by index) is likely a SWIFT FIN message. Exceptions are inherited from base implementation methods.
    
    Parameters:
    index - the unparsed text number
    
    Returns:
    true if the unparsed text at position index is a full SWIFT Message
    
    Throws:
    
    IllegalArgumentException - if parameter index is null
    
    IndexOutOfBoundsException - if parameter index is out of bounds
  - unparsedTextGetText
```
public String unparsedTextGetText(Integer index)
```
    get an unparsed text
    
    Parameters:
    index - the unparsed text number
    
    Returns:
    the requested text
    
    Throws:
    
    IllegalArgumentException - if parameter index is null
    
    IndexOutOfBoundsException - if parameter index is out of bounds
  - unparsedTextGetAsMessage
```
public SwiftMessage unparsedTextGetAsMessage(Integer index)
```
    get an unparsed text as a parsed swift message
    
    Parameters:
    index - the unparsed text number
    
    Returns:
    the blocks unparsed text at position index, parsed into a SwiftMessage object
    
    Throws:
    
    IllegalArgumentException - if parameter index is null
  - unparsedTextAddText
```
public void unparsedTextAddText(String text)
```
    adds a new unparsed text
    
    Parameters:
    text - the unparsed text to append
    
    Throws:
    
    IllegalArgumentException - if parameter text is null
  - unparsedTextAddText
```
public void unparsedTextAddText(SwiftMessage message)
```
    adds a new unparsed text from a message
    
    Parameters:
    message - the message to be appended
    
    Throws:
    
    IllegalArgumentException - if parameter message is null
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getInput
```
public Boolean getInput()
```
    Deprecated. use getBlockType()
    
    Only valid for block2, only when using hibernate for persistence
    
    Returns:
    true if the message block type is 2I
  - setInput
```
public void setInput(Boolean input)
```
    Only valid for block2, only when using hibernate for persistence
    
    Parameters:
    input - the is input parameter
  - getOutput
```
public Boolean getOutput()
```
    Deprecated. use getBlockType()
    
    Only valid for block2, only when using hibernate for persistence
    
    Returns:
    true if message block type is 2O
  - setOutput
```
public void setOutput(Boolean output)
```
    Only valid for block2, only when using hibernate for persistence
    
    Parameters:
    output - the is output parameter

Class SwiftBlock

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

unparsedTexts

input

output

blockType

Constructor Detail

SwiftBlock

SwiftBlock

Method Detail

getBlockType

setBlockType

setBlockNumber

setBlockName

getNumber

getName

getId

setId

toString

isTagBlock

unparsedTextVerify

getUnparsedTexts

setUnparsedTexts

getUnparsedTextsSize

unparsedTextIsMessage

unparsedTextGetText

unparsedTextGetAsMessage

unparsedTextAddText

unparsedTextAddText

hashCode

equals

getInput

setInput

getOutput

setOutput