com.prowidesoftware.swift.model

Class SwiftBlockUser

java.lang.Object

com.prowidesoftware.swift.model.SwiftBlock

com.prowidesoftware.swift.model.SwiftTagListBlock

com.prowidesoftware.swift.model.SwiftBlockUser

All Implemented Interfaces:

Serializable, Iterable<Tag>

public class SwiftBlockUser
extends SwiftTagListBlock
implements Serializable

Base class for SWIFT User "ad-hoc" Blocks (blocks with number other than 1-5 or names).

The assumption is that these User Defined Blocks are used and defined as tag blocks (meaning that these blocks behave like a block 3 or 5).

NOTE: this is not part of SWIFT standard, but seems to be common practice for users to append some locally defined blocks to annotate messages in a semi-compatible way (for example: add block 9 for some local information or block "S" for system reference).

Since:

5.0

Author:

www.prowidesoftware.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	blockName Block name.
protected Integer	sortKey Indicates the position of this user block in a message when persisted.

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

tags

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

blockType, id, input, output, unparsedTexts

Constructor Summary

Constructors

Constructor and Description
SwiftBlockUser() Default constructor
SwiftBlockUser(Integer blockNumber) Constructor for empty numbered user block
SwiftBlockUser(Integer blockNumber, List<Tag> tags) Constructor for numbered user block with tag initialization
SwiftBlockUser(String blockName) Constructor for named user block
SwiftBlockUser(String blockName, List<Tag> tags) Constructor for named user block with tag initialization

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBlockName() The block name.
String	getName() Returns the block name (this method is to be overwritten for derived classes).
Integer	getNumber() Returns the block number (if it can be converted to an integer, -1 otherwise).
Integer	getSortKey() get the sortkey of this user block when persisted
int	hashCode()
protected Boolean	isValidName() Checks if the block name (and or number) is valid for a user defined block.
static Boolean	isValidName(Integer blockNumber) Checks if the block number is valid for a user defined block.
static Boolean	isValidName(String blockName) Checks if the block name is valid for a user defined block.
static Boolean	isValidName(String blockName, Integer blockNumber) Checks if the block name and are valid for a user defined block.
protected void	setBlockName(String blockName) Sets the block name.
protected void	setBlockNumber(Integer blockNumber) Sets the block number.
void	setSortKey(Integer sortKey) Set the sortkey of this user block when persisted.

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

add, addTag, addTags, append, containsAllOf, containsAnyOf, containsField, containsTag, containsTag, containsTag, countAll, countByName, countTagsStarsWith, filterByName, filterByNameOrdered, getField, getFieldByName, getFieldByName, getFieldByName, getFieldByNumber, getFieldByNumber, getFieldsByName, getFieldsByName, getFieldsByNumber, getOptionalList, getOptionalList, getOptionalLists, getSubBlock, getSubBlock, getSubBlock, getSubBlock, getSubBlockAfterFirst, getSubBlockAfterLast, getSubBlockBeforeFirst, getSubBlockBeforeLast, getSubBlockByIndex, getSubBlockDelimitedWithOptionalTail, getSubBlocks, getSubBlocks, getSubBlocks, getSubBlocks, getSubBlocks, getSubBlocks, getSubBlocksDelimitedWithOptionalTail, getTag, getTagByName, getTagByNumber, getTagIndex, getTagMap, getTags, getTagsByContent, getTagsByName, getTagsByNumber, getTagsByValue, getTagValue, getTagValues, indexOfAnyFirst, indexOfAnyFirstAfterIndex, indexOfAnyLast, indexOfAnyLastAfterIndex, indexOfFirst, indexOfLast, 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, 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

Field Detail

blockName

protected String blockName

Block name. For integer numbered blocks, this will be the block number converted to string. For other blocks (for example: "S"), this will be the block real identifier and block number (if requested) will be -1.

Since:

5.0

sortKey

protected Integer sortKey

Indicates the position of this user block in a message when persisted. This value is used to remember the positions of the blocks inside a message when persisted. This value may not be set when persistence is not used and should not be used by clients.

Constructor Detail

SwiftBlockUser

public SwiftBlockUser()

Default constructor

Since:

5.0

SwiftBlockUser

public SwiftBlockUser(Integer blockNumber)

Constructor for empty numbered user block

Parameters:

blockNumber - the block number to initialize

Throws:

IllegalArgumentException - if parameter blockNumber is null

IllegalArgumentException - if parameter blockNumber is not a valid User Defined Block number (values 6..9)

Since:

5.0

SwiftBlockUser

public SwiftBlockUser(Integer blockNumber,
              List<Tag> tags)

Constructor for numbered user block with tag initialization

Parameters:

blockNumber - the block number to initialize

tags - the list of tags to initialize

Throws:

IllegalArgumentException - if parameter blockNumber or tags are null

IllegalArgumentException - if parameter blockNumber is not a valid User Defined Block number (values 6..9)

IllegalArgumentException - if parameter tags is not composed of Strings

Since:

5.0

SwiftBlockUser

public SwiftBlockUser(String blockName)

Constructor for named user block

Parameters:

blockName - the block name to initialize

Throws:

IllegalArgumentException - if parameter blockName is null

IllegalArgumentException - if parameter blockName is not a valid User Defined Block name (single letter)

Since:

5.0

SwiftBlockUser

public SwiftBlockUser(String blockName,
              List<Tag> tags)

Constructor for named user block with tag initialization

Parameters:

blockName - the block name to initialize

tags - the list of tags to initialize

Throws:

IllegalArgumentException - if parameter blockName or tags are null

IllegalArgumentException - if parameter blockName is not a valid User Defined Block name (single letter)

IllegalArgumentException - if parameter tags is not composed of Strings

Since:

5.0

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class SwiftTagListBlock

getBlockName

public String getBlockName()

The block name.

Returns:

the block name

Since:

5.0

getName

public String getName()

Description copied from class: SwiftBlock

Returns the block name (this method is to be overwritten for derived classes).

Overrides:

getName in class SwiftTagListBlock

Returns:

block name

See Also:

getBlockName()

getNumber

public Integer getNumber()

Returns the block number (if it can be converted to an integer, -1 otherwise).

Overrides:

getNumber in class SwiftTagListBlock

Returns:

Integer containing the block's name as an integer or -1 if the block name is not numeric

getSortKey

public Integer getSortKey()

get the sortkey of this user block when persisted

Returns:

an integer with the current sortkey

See Also:

sortKey

hashCode

public int hashCode()

Overrides:

hashCode in class SwiftTagListBlock

isValidName

protected Boolean isValidName()

Checks if the block name (and or number) is valid for a user defined block. The block name is considered valid if its numeric value is other than 1-5 and if its named identification value is a one char string, for example "S".

Returns:

true if the block name and number are valid

Since:

5.0

isValidName

public static Boolean isValidName(Integer blockNumber)

Checks if the block number is valid for a user defined block. Invalid blocks are blocks null or values 1-5 inclusive, all other values are considered valid.

Parameters:

blockNumber - the block number

Returns:

true if the block name and number are valid

Since:

5.0

isValidName

public static Boolean isValidName(String blockName)

Checks if the block name is valid for a user defined block.

Parameters:

blockName - the block name

Returns:

true if the block name and number are valid

Since:

5.0

isValidName

public static Boolean isValidName(String blockName,
                  Integer blockNumber)

Checks if the block name and are valid for a user defined block.

Parameters:

blockName - the block name

blockNumber - the block number

Returns:

true if the block name and number are valid

Since:

5.0

setBlockName

protected void setBlockName(String blockName)

Sets the block name.

Overrides:

setBlockName in class SwiftTagListBlock

Parameters:

blockName - the block name to set

Throws:

IllegalArgumentException - if parameter blockName is null

IllegalArgumentException - if parameter blockName is not a valid User Defined Block name (single letter)

Since:

5.0

setBlockNumber

protected void setBlockNumber(Integer blockNumber)

Sets the block number. This really sets blockName

Overrides:

setBlockNumber in class SwiftTagListBlock

Parameters:

blockNumber - the block number to set

Throws:

IllegalArgumentException - if parameter blockNumber is null

IllegalArgumentException - if parameter blockNumber is not a valid User Defined Block number (values 6..9)

Since:

5.0

setSortKey

public void setSortKey(Integer sortKey)

Set the sortkey of this user block when persisted. This value may be changed by clients when persistence is used and the order of the user blocks in a message are being modified.

Parameters:

sortKey - the new sortkey