com.prowidesoftware.swift.model

Class Tag

java.lang.Object

com.prowidesoftware.swift.model.Tag

All Implemented Interfaces:

java.io.Serializable

public class Tag
extends java.lang.Object
implements java.io.Serializable

Representation of a swift tag (also 'field' in computer terms) in a message.

NOTE

This class is also used inside SwiftBlock to store the value of a block that is not associated with a particular field, in this case, the Tag name attribute is set to null;

IMPORTANT NOTE ABOUT MULTILINE TAGS

Multiline tags are read with readline, so while swift defines \r\n to be the line terminator, the parser accepts a more wide range of line terminations. The values are stored in swift line terminators, that is always \r\n, so be aware that if a multiline field is separated with \n parse will be successfully but the returned value will be separated by \r\n

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 java.lang.Long	id Unique identified when this tag is a persisted element
protected java.lang.String	name Name of the tag, usually a number that may be followed by a letter.
protected SequenceNode	sequence Reference to the sequence node, if any, that this tags belongs to.
protected java.lang.Integer	sortKey Indicates the position of this tag in a message when persisted.
protected UnparsedTextList	unparsedTexts List of unparsed texts.
protected java.lang.String	value Value of the corresponding tag.

Constructor Summary

Constructors

Constructor and Description
Tag() Default constructor
Tag(java.lang.String inner) Create a tag from the value in inner.
Tag(java.lang.String tagname, java.lang.String value) Create a tag with the given tagname and value
Tag(java.lang.String tagname, java.lang.String value, UnparsedTextList unparsedText) Constructor for tag name and value and an unparsed text list
Tag(java.lang.String inner, UnparsedTextList unparsedText) Constructor for tag encoded value and an unparsed text list
Tag(UnparsedTextList unparsedText) Constructor for an unparsed text list

Method Summary

Methods

Modifier and Type	Method and Description
Field	asField()
boolean	contains(java.lang.String... values) Tell if this tag value contains any of the given values.
boolean	contains(java.lang.String searchStr) equivalent to StringUtils.contains(tag.getValue(), searchStr)
boolean	equals(java.lang.Object obj)
Field	getField()
java.lang.Long	getId() Get the unique identifier of the tag if it is persisted
java.lang.String	getLetterOption() Iterate the current tagname and return only letters as told by Character.isLetter(char)
java.lang.String	getName() Get the name of this tag
int	getNameAsInt() Attempt to parse the tag name as an integer.
java.lang.Integer	getNumber() Iterate the current tagname and return only number as told by Character.isDigit(char)
java.lang.Integer	getSortKey() get the sortkey of this tag
UnparsedTextList	getUnparsedTexts() returns the unparsed text list
java.lang.Integer	getUnparsedTextsSize() returns the size of the unparsed text list
java.lang.String	getValue() Get the value of the tag. Notice that in some cases the value can be null, for example the value of the "DLM" tag in this block: {5:{CHK:F9351591947F}{SYS:1610010606VNDZBET2AXXX0019000381}{DLM:}}
int	hashCode()
boolean	isNumber(int n) Tells if this tagname is a given number, so the integer 58 will match 58A and 58D.
void	setId(java.lang.Long id) Set the unique identifier of the tag if it is persisted
void	setName(java.lang.String name) Set the tag name
void	setNameValue(java.lang.String name, java.lang.String value) Shorthand equivalent to calling first setName(String) and then setValue(String)
void	setSortKey(java.lang.Integer sortKey) Set the sortkey of this tag.
void	setUnparsedTexts(UnparsedTextList texts) sets the list of unparsed texts
void	setValue(java.lang.String value) Sets the value of this tag.
boolean	startsWith(java.lang.String prefix) equivalent to StringUtils.startsWith(tag.getValue(), prefix)
java.lang.String	toString()
void	unparsedTextAddText(java.lang.String text) adds a new unparsed text
void	unparsedTextAddText(SwiftMessage message) adds a new unparsed text from a message
SwiftMessage	unparsedTextGetAsMessage(java.lang.Integer index) get an unparsed text as a parsed swift message
java.lang.String	unparsedTextGetText(java.lang.Integer index) get an unparsed text
java.lang.Boolean	unparsedTextIsMessage(java.lang.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 java.lang.Long id

Unique identified when this tag is a persisted element

name

protected java.lang.String name

Name of the tag, usually a number that may be followed by a letter. This value may be null.

sequence

protected SequenceNode sequence

Reference to the sequence node, if any, that this tags belongs to.

sortKey

protected java.lang.Integer sortKey

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

unparsedTexts

protected UnparsedTextList unparsedTexts

List of unparsed texts. For performance reasons, this will be null until really needed.

value

protected java.lang.String value

Value of the corresponding tag.

Constructor Detail

Tag

public Tag()

Default constructor

Tag

public Tag(java.lang.String inner)

Create a tag from the value in inner. If inner contains one : character, the string before is set as the tagname and the rest as the value. If inner contains more than one :, then the first value is used as previously described. If no : is contained, then all string is put in value and name remains null (useful for bloc data)
Maps:

 "" -> name=null, value=null
 "foo" -> name=null, value=foo
 ":foo" -> name=null, value=foo
 "foo:" -> name=foo, value=null
 "foo:bar" -> name=foo, value=bar
 

Parameters:

inner - the string to build the tag

Throws:

java.lang.IllegalArgumentException - if inner is null

Tag

public Tag(java.lang.String tagname,
   java.lang.String value)

Create a tag with the given tagname and value

Parameters:

tagname - name of this tag

value - the value of this tag

Throws:

java.lang.IllegalArgumentException - if parameter tagname or value are null

Tag

public Tag(java.lang.String tagname,
   java.lang.String value,
   UnparsedTextList unparsedText)

Constructor for tag name and value and an unparsed text list

Parameters:

tagname - name of this tag

value - the value of this tag

unparsedText - the list of unparsed texts

Throws:

java.lang.IllegalArgumentException - if parameter tagname or value are null

See Also:

Tag(String,String)

Tag

public Tag(java.lang.String inner,
   UnparsedTextList unparsedText)

Constructor for tag encoded value and an unparsed text list

Parameters:

inner - the string to build the tag

unparsedText - the list of unparsed texts

Throws:

java.lang.IllegalArgumentException - if parameter inner is null

See Also:

Tag(String)

Tag

public Tag(UnparsedTextList unparsedText)

Constructor for an unparsed text list

Parameters:

unparsedText - the list of unparsed texts

See Also:

Tag()

Method Detail

asField

public Field asField()

Returns:

this Tag as a FieldNN instance or null if an error occurs

contains

public boolean contains(java.lang.String... values)

Tell if this tag value contains any of the given values. This method is case sensitive. It handles null values. Actual test is delegated to StringUtils.contains(String,String)

Parameters:

values - variable list of values to test

Returns:

true if the value of this tag is one of the given values. returns false in any other case, including a null or empty list of values

contains

public boolean contains(java.lang.String searchStr)

equivalent to StringUtils.contains(tag.getValue(), searchStr)

See Also:

StringUtils.contains(String, String)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getField

public Field getField()

See Also:

Field.getField(Tag)

getId

public java.lang.Long getId()

Get the unique identifier of the tag if it is persisted

Returns:

the unique id or null if it is not a persistent object

getLetterOption

public java.lang.String getLetterOption()

Iterate the current tagname and return only letters as told by Character.isLetter(char)

Returns:

a string containing only letter characters of the tagname or null if no letters are found

getName

public java.lang.String getName()

Get the name of this tag

Returns:

a string with the current tag name

getNameAsInt

public int getNameAsInt()

Attempt to parse the tag name as an integer.

Returns:

the resulting value of parsing the tagname as an integer or -1 if an error occurs

getNumber

public java.lang.Integer getNumber()

Iterate the current tagname and return only number as told by Character.isDigit(char)

Returns:

an integer containing the numeric of the tagname or null if no digits are found

Since:

6.2

getSortKey

public java.lang.Integer getSortKey()

get the sortkey of this tag

Returns:

an integer with the current sortkey

See Also:

sortKey

getUnparsedTexts

public UnparsedTextList getUnparsedTexts()

returns the unparsed text list

Returns:

the unparsed text attached to this tag object

getUnparsedTextsSize

public java.lang.Integer getUnparsedTextsSize()

returns the size of the unparsed text list

Returns:

the count of unparsed texts attached to this tag object

getValue

public java.lang.String getValue()

Get the value of the tag.
Notice that in some cases the value can be null, for example the value of the "DLM" tag in this block:
{5:{CHK:F9351591947F}{SYS:1610010606VNDZBET2AXXX0019000381}{DLM:}}

Returns:

a string with the value of the tag or null if the value was not set

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isNumber

public boolean isNumber(int n)

Tells if this tagname is a given number, so the integer 58 will match 58A and 58D.

Parameters:

n - the number that this tagname will be compared to

Returns:

true if this tagname starts with the given number or false in any other case

setId

public void setId(java.lang.Long id)

Set the unique identifier of the tag if it is persisted

Parameters:

id - the id to be set

See Also:

sortKey

setName

public void setName(java.lang.String name)

Set the tag name

Parameters:

name - the name of the tag to be set

Throws:

java.lang.IllegalArgumentException - if parameter name is null

setNameValue

public void setNameValue(java.lang.String name,
                java.lang.String value)

Shorthand equivalent to calling first setName(String) and then setValue(String)

Parameters:

name - the tagname

value - the tagvalue

setSortKey

public void setSortKey(java.lang.Integer sortKey)

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

Parameters:

sortKey - the new sortkey

setUnparsedTexts

public void setUnparsedTexts(UnparsedTextList texts)

sets the list of unparsed texts

Parameters:

texts - the new list of unparsed texts (may be null)

setValue

public void setValue(java.lang.String value)

Sets the value of this tag.

Parameters:

value - the value for the tag, may be null

startsWith

public boolean startsWith(java.lang.String prefix)

equivalent to StringUtils.startsWith(tag.getValue(), prefix)

See Also:

StringUtils.startsWith(String, String)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

unparsedTextAddText

public void unparsedTextAddText(java.lang.String text)

adds a new unparsed text

Parameters:

text - the unparsed text to append

Throws:

java.lang.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:

java.lang.IllegalArgumentException - if parameter message is null

unparsedTextGetAsMessage

public SwiftMessage unparsedTextGetAsMessage(java.lang.Integer index)

get an unparsed text as a parsed swift message

Parameters:

index - the unparsed text number

Returns:

the unparsed text at position index parsed into a SwiftMessage object

Throws:

java.lang.IllegalArgumentException - if parameter index is null

unparsedTextGetText

public java.lang.String unparsedTextGetText(java.lang.Integer index)

get an unparsed text

Parameters:

index - the unparsed text number

Returns:

the requested text

Throws:

java.lang.IllegalArgumentException - if parameter index is null

java.lang.IndexOutOfBoundsException - if parameter index is out of bounds

unparsedTextIsMessage

public java.lang.Boolean unparsedTextIsMessage(java.lang.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:

java.lang.IllegalArgumentException - if parameter index is null

java.lang.IndexOutOfBoundsException - if parameter index is out of bounds

unparsedTextVerify

protected void unparsedTextVerify()

verifies that the unparsed text list exists