com.prowidesoftware.swift.model

Class SwiftBlock3

java.lang.Object

com.prowidesoftware.swift.model.SwiftBlock

com.prowidesoftware.swift.model.SwiftTagListBlock

com.prowidesoftware.swift.model.SwiftBlock3

All Implemented Interfaces:

Serializable, Iterable<Tag>

public class SwiftBlock3
extends SwiftTagListBlock
implements Serializable

Base class for SWIFT User Header Block (block 3).
This block is optional, and contains special processing instructions.

Since:

4.0

Author:

www.prowidesoftware.com

See Also:

Serialized Form

Field Summary

Fields inherited from class com.prowidesoftware.swift.model.SwiftTagListBlock

EMPTY_LIST, tags

Fields inherited from class com.prowidesoftware.swift.model.SwiftBlock

blockType, id, input, output, unparsedTexts

Constructor Summary

Constructors

Constructor and Description
SwiftBlock3() Default constructor
SwiftBlock3(List<Tag> tags) Constructor with tag initialization

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Returns the block name (the value 3 as a string)
Integer	getNumber() Returns the block number (the value 3 as an integer)
Boolean	isSTP() Indicates if the message is a Straight Through Processing (STP)
protected void	setBlockName(String blockName) Sets the block name.
protected void	setBlockNumber(Integer blockNumber) Sets the block number.

Methods inherited from class com.prowidesoftware.swift.model.SwiftTagListBlock

add, addTag, addTags, append, append, append, append, append, append, asTagArray, clear, containsAllOf, containsAnyOf, containsField, containsTag, containsTag, containsTag, countAll, countByName, countTagsStarsWith, equals, filterByName, filterByNameOrdered, getField, getFieldByName, getFieldByName, getFieldByName, getFieldByNumber, getFieldByNumber, getFieldsByName, getFieldsByName, getFieldsByNumber, getOptionalList, getOptionalList, getOptionalLists, getSubBlock, getSubBlock, getSubBlock, getSubBlock, getSubBlockAfterFirst, getSubBlockAfterFirst, getSubBlockAfterLast, getSubBlockBeforeFirst, getSubBlockBeforeLast, getSubBlockByIndex, getSubBlockByTagNames, getSubBlockDelimitedWithOptionalTail, getSubBlocks, getSubBlocks, getSubBlocks, getSubBlocks, getSubBlocks, getSubBlocks, getSubBlocksByTagNames, getSubBlocksDelimitedWithOptionalTail, getTag, getTagByName, getTagByName, getTagByNumber, getTagCount, getTagCount, getTagIndex, getTagMap, getTags, getTagsByContent, getTagsByName, getTagsByNumber, getTagsByValue, getTagValue, getTagValues, hashCode, indexOfAnyFirst, indexOfAnyFirstAfterIndex, indexOfAnyLast, indexOfAnyLastAfterIndex, indexOfFirst, indexOfFirstValue, indexOfLast, indexOfLastValue, isEmpty, iterator, removeAfterFirst, removeAfterFirstStartsWith, removeAll, removeSubBlock, removeTag, removeUntilFirst, setTags, setTags, size, splitByTagName, sublist, tagIterator, tagNamesList, toJson, toString, trimAfterFirst, visit

Methods inherited from class com.prowidesoftware.swift.model.SwiftBlock

getBlockType, getId, getInput, getOutput, getUnparsedTexts, getUnparsedTextsSize, isTagBlock, setBlockType, setId, setInput, setOutput, setUnparsedTexts, unparsedTextAddText, unparsedTextAddText, unparsedTextGetAsMessage, unparsedTextGetText, unparsedTextIsMessage, unparsedTextVerify

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SwiftBlock3

public SwiftBlock3()

Default constructor

SwiftBlock3

public SwiftBlock3(List<Tag> tags)

Constructor with tag initialization

Parameters:

tags - the list of tags to initialize

Since:

5.0

Method Detail

setBlockNumber

protected void setBlockNumber(Integer blockNumber)

Sets the block number. Will cause an exception unless setting block number to 3.

Overrides:

setBlockNumber in class SwiftTagListBlock

Parameters:

blockNumber - the block number to set

Throws:

IllegalArgumentException - if parameter blockName is not the integer 3

Since:

5.0

setBlockName

protected void setBlockName(String blockName)

Sets the block name. Will cause an exception unless setting block number to "3".

Overrides:

setBlockName in class SwiftTagListBlock

Parameters:

blockName - the block name to set

Throws:

IllegalArgumentException - if parameter blockName is not the string "3"

Since:

5.0

getNumber

public Integer getNumber()

Returns the block number (the value 3 as an integer)

Overrides:

getNumber in class SwiftTagListBlock

Returns:

Integer containing the block's number

getName

public String getName()

Returns the block name (the value 3 as a string)

Overrides:

getName in class SwiftTagListBlock

Returns:

block name

Since:

5.0

isSTP

public Boolean isSTP()

Indicates if the message is a Straight Through Processing (STP)

Returns:

true if the message is STP