public class SwiftBlockUser extends SwiftTagListBlock implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
blockName
Block name.
|
protected java.lang.Integer |
sortKey
Indicates the position of this user block in a message when persisted.
|
EMPTY_LIST
blockType, input, output, unparsedTexts
Constructor and Description |
---|
SwiftBlockUser()
Default constructor
|
SwiftBlockUser(java.lang.Integer blockNumber)
Constructor for empty numbered user block
|
SwiftBlockUser(java.lang.Integer blockNumber,
java.util.List<Tag> tags)
Constructor for numbered user block with tag initialization
|
SwiftBlockUser(java.lang.String blockName)
Constructor for named user block
|
SwiftBlockUser(java.lang.String blockName,
java.util.List<Tag> tags)
Constructor for named user block with tag initialization
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object o) |
static SwiftBlockUser |
fromJson(java.lang.String json)
This method deserializes the JSON data into an user block object.
|
java.lang.String |
getBlockName()
The block name.
|
java.lang.String |
getName()
Returns the block name (this method is to be overwritten for derived classes).
|
java.lang.Integer |
getNumber()
Returns the block number (if it can be converted to an integer, -1 otherwise).
|
java.lang.Integer |
getSortKey()
get the sortkey of this user block when persisted
|
int |
hashCode() |
protected java.lang.Boolean |
isValidName()
Checks if the block name (and or number) is valid for a user defined block.
|
static java.lang.Boolean |
isValidName(java.lang.Integer blockNumber)
Checks if the block number is valid for a user defined block.
|
static java.lang.Boolean |
isValidName(java.lang.String blockName)
Checks if the block name is valid for a user defined block.
|
static java.lang.Boolean |
isValidName(java.lang.String blockName,
java.lang.Integer blockNumber)
Checks if the block name and are valid for a user defined block.
|
protected void |
setBlockName(java.lang.String blockName)
Sets the block name.
|
protected void |
setBlockNumber(java.lang.Integer blockNumber)
Sets the block number.
|
void |
setSortKey(java.lang.Integer sortKey)
Set the sortkey of this user block when persisted.
|
addTag, addTags, append, append, append, append, append, append, asTagArray, clear, containsAllOf, containsAnyOf, containsField, containsTag, containsTag, containsTag, countAll, countByName, countTagsStarsWith, fields, filterByName, filterByNameOrdered, getField, getFieldByName, getFieldByName, getFieldByName, getFieldByNumber, getFieldByNumber, getFieldByQualifiers, getFieldsByName, getFieldsByName, getFieldsByNumber, getOptionalList, getOptionalList, getOptionalLists, getSubBlock, getSubBlock, getSubBlock, getSubBlock, getSubBlockAfterFirst, getSubBlockAfterFirst, getSubBlockAfterLast, getSubBlockBeforeFirst, getSubBlockBeforeFirst, getSubBlockBeforeLast, getSubBlockByTagNames, getSubBlockDelimitedWithOptionalTail, getSubBlocks, getSubBlocks, getSubBlocks, getSubBlocks, getSubBlocks, getSubBlocks, getSubBlocksByTagNames, getSubBlocksDelimitedWithOptionalTail, getTag, getTagByName, getTagByName, getTagByNumber, getTagIndex, getTagMap, getTags, getTagsByContent, getTagsByName, getTagsByName, getTagsByNumber, getTagsByValue, getTagValue, getTagValues, indexOfAnyFirst, indexOfAnyFirstAfterIndex, indexOfAnyLast, indexOfAnyLastAfterIndex, indexOfFirst, indexOfFirstValue, indexOfLast, indexOfLastValue, isEmpty, iterator, removeAfterFirstStartsWith, removeAll, removeSubBlock, removeSubBlocks, removeTag, setTag, setTags, setTags, size, splitByTagName, splitByTagName, sublist, tagIterator, tagNamesList, toJson, toString, visit
getBlockType, getInput, getOutput, getUnparsedTexts, getUnparsedTextsSize, isTagBlock, setBlockType, setInput, setOutput, setUnparsedTexts, unparsedTextAddText, unparsedTextAddText, unparsedTextGetAsMessage, unparsedTextGetText, unparsedTextIsMessage, unparsedTextVerify
protected java.lang.Integer sortKey
protected java.lang.String blockName
public SwiftBlockUser()
public SwiftBlockUser(java.lang.Integer blockNumber)
blockNumber
- the block number to initializejava.lang.IllegalArgumentException
- if parameter blockNumber is nulljava.lang.IllegalArgumentException
- if parameter blockNumber is not a valid User Defined Block number (values 6..9)public SwiftBlockUser(java.lang.Integer blockNumber, java.util.List<Tag> tags)
blockNumber
- the block number to initializetags
- the list of tags to initializejava.lang.IllegalArgumentException
- if parameter blockNumber or tags are nulljava.lang.IllegalArgumentException
- if parameter blockNumber is not a valid User Defined Block number (values 6..9)java.lang.IllegalArgumentException
- if parameter tags is not composed of Stringspublic SwiftBlockUser(java.lang.String blockName)
blockName
- the block name to initializejava.lang.IllegalArgumentException
- if parameter blockName is nulljava.lang.IllegalArgumentException
- if parameter blockName is not a valid User Defined Block name (single letter)public SwiftBlockUser(java.lang.String blockName, java.util.List<Tag> tags)
blockName
- the block name to initializetags
- the list of tags to initializejava.lang.IllegalArgumentException
- if parameter blockName or tags are nulljava.lang.IllegalArgumentException
- if parameter blockName is not a valid User Defined Block name (single letter)java.lang.IllegalArgumentException
- if parameter tags is not composed of Stringspublic static java.lang.Boolean isValidName(java.lang.String blockName, java.lang.Integer blockNumber)
blockName
- the block nameblockNumber
- the block numberpublic static java.lang.Boolean isValidName(java.lang.String blockName)
blockName
- the block namepublic static java.lang.Boolean isValidName(java.lang.Integer blockNumber)
blockNumber
- the block numberpublic static SwiftBlockUser fromJson(java.lang.String json)
SwiftTagListBlock.toJson()
public java.lang.Integer getNumber()
getNumber
in class SwiftTagListBlock
public java.lang.String getName()
SwiftBlock
getName
in class SwiftTagListBlock
getBlockName()
public java.lang.String getBlockName()
protected void setBlockName(java.lang.String blockName)
setBlockName
in class SwiftTagListBlock
blockName
- the block name to setjava.lang.IllegalArgumentException
- if parameter blockName is nulljava.lang.IllegalArgumentException
- if parameter blockName is not a valid User Defined Block name (single letter)protected void setBlockNumber(java.lang.Integer blockNumber)
blockName
setBlockNumber
in class SwiftTagListBlock
blockNumber
- the block number to setjava.lang.IllegalArgumentException
- if parameter blockNumber is nulljava.lang.IllegalArgumentException
- if parameter blockNumber is not a valid User Defined Block number (values 6..9)protected java.lang.Boolean isValidName()
public java.lang.Integer getSortKey()
sortKey
public void setSortKey(java.lang.Integer sortKey)
sortKey
- the new sortkeypublic boolean equals(java.lang.Object o)
equals
in class SwiftTagListBlock
public int hashCode()
hashCode
in class SwiftTagListBlock