com.prowidesoftware.swift.model.field

Class Field27

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field27

All Implemented Interfaces:

JsonSerializable, PatternContainer, java.io.Serializable

@Generated
public class Field27
extends Field
implements java.io.Serializable

SWIFT MT Field 27.

Model and parser for field 27 of a SWIFT MT message.

Subfields (components) Data types

1. Long
2. Long

Structure definition

• validation pattern: 1n/1n
• parser pattern: S/S
• components pattern: NN

This class complies with standard release SRU2021

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENTS_PATTERN Deprecated. Use typesPattern() method instead.
static java.lang.String	F_27 Same as NAME, intended to be clear when using static imports.
static java.lang.Integer	MESSAGE_NUMBER Alternative constant name for field's Number Component number.
static java.lang.String	NAME Constant with the field name 27.
static java.lang.Integer	NUMBER Component number for the Number subfield.
static java.lang.String	PARSER_PATTERN Deprecated. Use parserPattern() method instead.
static java.lang.Integer	SEQUENCE_NUMBER Alternative constant name for field's Total Component number.
static int	SRU Constant identifying the SRU to which this class belongs to.
static java.lang.Integer	TOTAL Component number for the Total subfield.
static java.lang.String	TYPES_PATTERN Deprecated. Use typesPattern() method instead.

Fields inherited from class com.prowidesoftware.swift.model.field.Field

components

Constructor Summary

Constructors

Constructor and Description
Field27() Default constructor.
Field27(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field27(Tag tag) Creates a new field and initializes its components with content from the parameter tag.

Method Summary

Modifier and Type	Method and Description
java.lang.String	componentsPattern() Deprecated. Use typesPattern() instead.
int	componentsSize() Returns the defined amount of components. This is not the amount of components present in the field instance, but the total amount of components that this field accepts as defined.
static Tag	emptyTag() Create a Tag with this field name and an empty string as value.
static Field27	fromJson(java.lang.String json) This method deserializes the JSON data into a Field27 object.
static Field27	get(SwiftMessage msg) Gets the first instance of Field27 in the given message.
static Field27	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field27>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field27 in the given message an empty list is returned if none found.
static java.util.List<Field27>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field27 from the given block an empty list is returned if none found.
java.lang.String	getComponent1() Gets the component 1 (Number).
java.lang.Long	getComponent1AsLong() Get the component 1 as Long
java.lang.Number	getComponent1AsNumber() Deprecated.
java.lang.String	getComponent2() Gets the component 2 (Total).
java.lang.Long	getComponent2AsLong() Get the component 2 as Long
java.lang.Number	getComponent2AsNumber() Deprecated.
java.util.List<java.lang.String>	getComponentLabels() Returns english label for components.
protected java.util.Map<java.lang.Integer,java.lang.String>	getComponentMap() Returns a mapping between component numbers and their label in camel case format.
java.lang.String	getMessageNumber() Alternative method getter for field's Number
java.lang.Long	getMessageNumberAsLong() Alternative method getter for field's Number as Long
java.lang.Number	getMessageNumberAsNumber() Deprecated.
java.lang.String	getName() Returns the field's name composed by the field number and the letter option (if any).
java.lang.String	getNumber() Gets the Number (component 1).
java.lang.Long	getNumberAsLong() Get the Number (component 1) as Long
java.lang.Number	getNumberAsNumber() Deprecated.
java.lang.String	getSequenceNumber() Alternative method getter for field's Total
java.lang.Long	getSequenceNumberAsLong() Alternative method getter for field's Total as Long
java.lang.Number	getSequenceNumberAsNumber() Deprecated.
java.lang.String	getTotal() Gets the Total (component 2).
java.lang.Long	getTotalAsLong() Get the Total (component 2) as Long
java.lang.Number	getTotalAsNumber() Deprecated.
java.lang.String	getValue() Serializes the fields' components into the single string value (SWIFT format)
java.lang.String	getValueDisplay(int component, java.util.Locale locale) Returns a localized suitable for showing to humans string of a field component.
boolean	isGeneric() Returns true if the field is a GENERIC FIELD as specified by the standard.
boolean	isOptional(int component) Given a component number it returns true if the component is optional, regardless of the field being mandatory in a particular message. Being the field's value conformed by a composition of one or several internal component values, the field may be present in a message with a proper value but with some of its internal components not set.
static Field27	newInstance(Field27 source) Copy constructor.
void	parse(java.lang.String value) Parses the parameter value into the internal components structure.
java.lang.String	parserPattern() Returns the field parser pattern.
Field27	setComponent1(java.lang.Long component1) Set the component1 from a Long object.
Field27	setComponent1(java.lang.Number component1) Alternative method setter for field's Number (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field27	setComponent1(java.lang.String component1) Set the component 1 (Number).
Field27	setComponent2(java.lang.Long component2) Set the component2 from a Long object.
Field27	setComponent2(java.lang.Number component2) Alternative method setter for field's Total (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field27	setComponent2(java.lang.String component2) Set the component 2 (Total).
Field27	setMessageNumber(java.lang.Long component1) Alternative method setter for field's Number from a Long object.
Field27	setMessageNumber(java.lang.Number component1) Alternative method setter for field's Number (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field27	setMessageNumber(java.lang.String component1) Alternative method setter for field's Number
Field27	setNumber(java.lang.Long component1) Set the Number (component 1) from a Long object.
Field27	setNumber(java.lang.Number component1) Alternative method setter for field's Number (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field27	setNumber(java.lang.String component1) Set the Number (component 1).
Field27	setSequenceNumber(java.lang.Long component2) Alternative method setter for field's Total from a Long object.
Field27	setSequenceNumber(java.lang.Number component2) Alternative method setter for field's Total (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field27	setSequenceNumber(java.lang.String component2) Alternative method setter for field's Total
Field27	setTotal(java.lang.Long component2) Set the Total (component 2) from a Long object.
Field27	setTotal(java.lang.Number component2) Alternative method setter for field's Total (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field27	setTotal(java.lang.String component2) Set the Total (component 2).
static Tag	tag(java.lang.String value) Create a Tag with this field name and the given value.
java.lang.String	typesPattern() Returns the field component types pattern.
java.lang.String	validatorPattern() Returns the field validator pattern

Methods inherited from class com.prowidesoftware.swift.model.field.Field

append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toJson, toString, validName

Methods inherited from class java.lang.Object

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

Field Detail

SRU

public static final int SRU

Constant identifying the SRU to which this class belongs to.

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

Constant with the field name 27.

See Also:

Constant Field Values

F_27

public static final java.lang.String F_27

Same as NAME, intended to be clear when using static imports.

See Also:

Constant Field Values

PARSER_PATTERN

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.String PARSER_PATTERN

Deprecated. Use parserPattern() method instead.

See Also:

Constant Field Values

COMPONENTS_PATTERN

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.String COMPONENTS_PATTERN

Deprecated. Use typesPattern() method instead.

See Also:

Constant Field Values

TYPES_PATTERN

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.String TYPES_PATTERN

Deprecated. Use typesPattern() method instead.

See Also:

Constant Field Values

NUMBER

public static final java.lang.Integer NUMBER

Component number for the Number subfield.

MESSAGE_NUMBER

public static final java.lang.Integer MESSAGE_NUMBER

Alternative constant name for field's Number Component number.

See Also:

NUMBER

TOTAL

public static final java.lang.Integer TOTAL

Component number for the Total subfield.

SEQUENCE_NUMBER

public static final java.lang.Integer SEQUENCE_NUMBER

Alternative constant name for field's Total Component number.

See Also:

TOTAL

Constructor Detail

Field27

public Field27()

Default constructor. Creates a new field setting all components to null.

Field27

public Field27(java.lang.String value)

Creates a new field and initializes its components with content from the parameter value.

Parameters:

value - complete field value including separators and CRLF

Field27

public Field27(Tag tag)

Creates a new field and initializes its components with content from the parameter tag. The value is parsed with parse(String)

Throws:

java.lang.IllegalArgumentException - if the parameter tag is null or its tagname does not match the field name

Since:

7.8

Method Detail

newInstance

public static Field27 newInstance(Field27 source)

Copy constructor. Initializes the components list with a deep copy of the source components list.

Parameters:

source - a field instance to copy

Since:

7.7

tag

public static Tag tag(java.lang.String value)

Create a Tag with this field name and the given value. Shorthand for new Tag(NAME, value)

Since:

7.5

See Also:

NAME

emptyTag

public static Tag emptyTag()

Create a Tag with this field name and an empty string as value. Shorthand for new Tag(NAME, "")

Since:

7.5

See Also:

NAME

parse

public void parse(java.lang.String value)

Parses the parameter value into the internal components structure.

Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.

Specified by:

parse in class Field

Parameters:

value - complete field value including separators and CRLF

Since:

7.8

getValue

public java.lang.String getValue()

Serializes the fields' components into the single string value (SWIFT format)

Specified by:

getValue in class Field

Returns:

SWIFT formatted value

getValueDisplay

public java.lang.String getValueDisplay(int component,
                                        java.util.Locale locale)

Returns a localized suitable for showing to humans string of a field component.

Specified by:

getValueDisplay in class Field

Parameters:

component - number of the component to display

locale - optional locale to format date and amounts, if null, the default locale is used

Returns:

formatted component value or null if component number is invalid or not present

Throws:

java.lang.IllegalArgumentException - if component number is invalid for the field

Since:

7.8

componentsPattern

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.String componentsPattern()

Deprecated. Use typesPattern() instead.

Description copied from class: Field

Returns the field components pattern This method is DEPRECATED, use typesPattern() instead.

Specified by:

componentsPattern in class Field

Returns:

the static value of Field${dto.getField()}.COMPONENTS_PATTERN

See Also:

Field.typesPattern()

typesPattern

public java.lang.String typesPattern()

Returns the field component types pattern. This method returns a letter representing the type for each component in the Field. It supersedes the Components Pattern because it distinguishes between N (Number) and I (BigDecimal).

Specified by:

typesPattern in interface PatternContainer

Specified by:

typesPattern in class Field

Since:

9.2.7

parserPattern

public java.lang.String parserPattern()

Returns the field parser pattern.

Specified by:

parserPattern in interface PatternContainer

validatorPattern

public java.lang.String validatorPattern()

Returns the field validator pattern

Specified by:

validatorPattern in class Field

isOptional

public boolean isOptional(int component)

Given a component number it returns true if the component is optional, regardless of the field being mandatory in a particular message.
Being the field's value conformed by a composition of one or several internal component values, the field may be present in a message with a proper value but with some of its internal components not set.

Specified by:

isOptional in class Field

Parameters:

component - component number, first component of a field is referenced as 1

Returns:

true if the component is optional for this field, false otherwise

isGeneric

public boolean isGeneric()

Returns true if the field is a GENERIC FIELD as specified by the standard.

Specified by:

isGeneric in class Field

Returns:

true if the field is generic, false otherwise

componentsSize

public int componentsSize()

Returns the defined amount of components.
This is not the amount of components present in the field instance, but the total amount of components that this field accepts as defined.

Specified by:

componentsSize in class Field

Since:

7.7

getComponentLabels

public java.util.List<java.lang.String> getComponentLabels()

Returns english label for components.
The index in the list is in sync with specific field component structure.

Specified by:

getComponentLabels in class Field

Since:

7.8.4

See Also:

Field.getComponentLabel(int)

getComponentMap

protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()

Returns a mapping between component numbers and their label in camel case format.

Specified by:

getComponentMap in class Field

Since:

7.10.3

getComponent1

public java.lang.String getComponent1()

Gets the component 1 (Number).

Returns:

the component 1

getComponent1AsLong

public java.lang.Long getComponent1AsLong()

Get the component 1 as Long

Returns:

the component 1 converted to Long or null if cannot be converted

Since:

9.2.7

getComponent1AsNumber

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getComponent1AsNumber()

Deprecated.

Get the component 1 as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent1AsLong() to get the proper value.

Returns:

the component 1 converted to Number (BigDecimal) or null if cannot be converted

See Also:

getComponent1AsLong()

getNumber

public java.lang.String getNumber()

Gets the Number (component 1).

Returns:

the Number from component 1

getMessageNumber

public java.lang.String getMessageNumber()

Alternative method getter for field's Number

Since:

9.2.7

See Also:

getNumber()

getNumberAsLong

public java.lang.Long getNumberAsLong()

Get the Number (component 1) as Long

Returns:

the Number from component 1 converted to Long or null if cannot be converted

Since:

9.2.7

getNumberAsNumber

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getNumberAsNumber()

Deprecated.

Get the Number (component 1) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent1AsLong() to get the proper value.

Returns:

the component 1 converted to Number (BigDecimal) or null if cannot be converted

See Also:

getNumberAsLong()

getMessageNumberAsLong

public java.lang.Long getMessageNumberAsLong()

Alternative method getter for field's Number as Long

Since:

9.2.7

See Also:

getNumberAsLong()

getMessageNumberAsNumber

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getMessageNumberAsNumber()

Deprecated.

Alternative method getter for field's Number (component 1) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent1AsLong() to get the proper value.

Returns:

the component 1 converted to Number (BigDecimal) or null if cannot be converted

See Also:

getNumberAsLong()

getComponent2

public java.lang.String getComponent2()

Gets the component 2 (Total).

Returns:

the component 2

getComponent2AsLong

public java.lang.Long getComponent2AsLong()

Get the component 2 as Long

Returns:

the component 2 converted to Long or null if cannot be converted

Since:

9.2.7

getComponent2AsNumber

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getComponent2AsNumber()

Deprecated.

Get the component 2 as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent2AsLong() to get the proper value.

Returns:

the component 2 converted to Number (BigDecimal) or null if cannot be converted

See Also:

getComponent2AsLong()

getTotal

public java.lang.String getTotal()

Gets the Total (component 2).

Returns:

the Total from component 2

getSequenceNumber

public java.lang.String getSequenceNumber()

Alternative method getter for field's Total

Since:

9.2.7

See Also:

getTotal()

getTotalAsLong

public java.lang.Long getTotalAsLong()

Get the Total (component 2) as Long

Returns:

the Total from component 2 converted to Long or null if cannot be converted

Since:

9.2.7

getTotalAsNumber

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getTotalAsNumber()

Deprecated.

Get the Total (component 2) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent2AsLong() to get the proper value.

Returns:

the component 2 converted to Number (BigDecimal) or null if cannot be converted

See Also:

getTotalAsLong()

getSequenceNumberAsLong

public java.lang.Long getSequenceNumberAsLong()

Alternative method getter for field's Total as Long

Since:

9.2.7

See Also:

getTotalAsLong()

getSequenceNumberAsNumber

@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public java.lang.Number getSequenceNumberAsNumber()

Deprecated.

Alternative method getter for field's Total (component 2) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent2AsLong() to get the proper value.

Returns:

the component 2 converted to Number (BigDecimal) or null if cannot be converted

See Also:

getTotalAsLong()

setComponent1

public Field27 setComponent1(java.lang.String component1)

Set the component 1 (Number).

Parameters:

component1 - the Number to set

Returns:

the field object to enable build pattern

setComponent1

public Field27 setComponent1(java.lang.Long component1)

Set the component1 from a Long object.
If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent1(String) method.

Parameters:

component1 - the Long with the Number content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent1(String)

setComponent1

public Field27 setComponent1(java.lang.Number component1)

Alternative method setter for field's Number (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

Parameters:

component1 - the Number with the Number content to set

Returns:

the field object to enable build pattern

See Also:

setNumber(java.lang.Long)

setNumber

public Field27 setNumber(java.lang.String component1)

Set the Number (component 1).

Parameters:

component1 - the Number to set

Returns:

the field object to enable build pattern

setNumber

public Field27 setNumber(java.lang.Long component1)

Set the Number (component 1) from a Long object.

Parameters:

component1 - Long with the Number content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent1(java.lang.Long)

setNumber

public Field27 setNumber(java.lang.Number component1)

Alternative method setter for field's Number (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

Parameters:

component1 - the Number with the Number content to set

Returns:

the field object to enable build pattern

See Also:

setNumber(java.lang.Long)

setMessageNumber

public Field27 setMessageNumber(java.lang.String component1)

Alternative method setter for field's Number

Parameters:

component1 - the Number to set

Returns:

the field object to enable build pattern

See Also:

setNumber(String)

setMessageNumber

public Field27 setMessageNumber(java.lang.Long component1)

Alternative method setter for field's Number from a Long object.

Parameters:

component1 - Long with the Number content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent1(java.lang.Long)

setMessageNumber

public Field27 setMessageNumber(java.lang.Number component1)

Alternative method setter for field's Number (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

Parameters:

component1 - the Number with the Number content to set

Returns:

the field object to enable build pattern

See Also:

setNumber(java.lang.Long)

setComponent2

public Field27 setComponent2(java.lang.String component2)

Set the component 2 (Total).

Parameters:

component2 - the Total to set

Returns:

the field object to enable build pattern

setComponent2

public Field27 setComponent2(java.lang.Long component2)

Set the component2 from a Long object.
If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent2(String) method.

Parameters:

component2 - the Long with the Total content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent2(String)

setComponent2

public Field27 setComponent2(java.lang.Number component2)

Alternative method setter for field's Total (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

Parameters:

component2 - the Number with the Total content to set

Returns:

the field object to enable build pattern

See Also:

setTotal(java.lang.Long)

setTotal

public Field27 setTotal(java.lang.String component2)

Set the Total (component 2).

Parameters:

component2 - the Total to set

Returns:

the field object to enable build pattern

setTotal

public Field27 setTotal(java.lang.Long component2)

Set the Total (component 2) from a Long object.

Parameters:

component2 - Long with the Total content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent2(java.lang.Long)

setTotal

public Field27 setTotal(java.lang.Number component2)

Alternative method setter for field's Total (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

Parameters:

component2 - the Number with the Total content to set

Returns:

the field object to enable build pattern

See Also:

setTotal(java.lang.Long)

setSequenceNumber

public Field27 setSequenceNumber(java.lang.String component2)

Alternative method setter for field's Total

Parameters:

component2 - the Total to set

Returns:

the field object to enable build pattern

See Also:

setTotal(String)

setSequenceNumber

public Field27 setSequenceNumber(java.lang.Long component2)

Alternative method setter for field's Total from a Long object.

Parameters:

component2 - Long with the Total content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent2(java.lang.Long)

setSequenceNumber

public Field27 setSequenceNumber(java.lang.Number component2)

Alternative method setter for field's Total (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

Parameters:

component2 - the Number with the Total content to set

Returns:

the field object to enable build pattern

See Also:

setTotal(java.lang.Long)

getName

public java.lang.String getName()

Returns the field's name composed by the field number and the letter option (if any).

Specified by:

getName in class Field

Returns:

the static value of Field27.NAME

get

public static Field27 get(SwiftTagListBlock block)

Gets the first occurrence form the tag list or null if not found.

Parameters:

block - may be null or empty

Returns:

null if not found o block is null or empty

get

public static Field27 get(SwiftMessage msg)

Gets the first instance of Field27 in the given message.

Parameters:

msg - may be empty or null

Returns:

null if not found or msg is empty or null

See Also:

get(SwiftTagListBlock)

getAll

public static java.util.List<Field27> getAll(SwiftMessage msg)

Gets a list of all occurrences of the field Field27 in the given message an empty list is returned if none found.

Parameters:

msg - may be empty or null in which case an empty list is returned

See Also:

getAll(SwiftTagListBlock)

getAll

public static java.util.List<Field27> getAll(SwiftTagListBlock block)

Gets a list of all occurrences of the field Field27 from the given block an empty list is returned if none found.

Parameters:

block - may be empty or null in which case an empty list is returned

fromJson

public static Field27 fromJson(java.lang.String json)

This method deserializes the JSON data into a Field27 object.

Parameters:

json - JSON structure including tuples with label and value for all field components

Returns:

a new field instance with the JSON data parsed into field components or an empty field id the JSON is invalid

Since:

7.10.3

See Also:

Field.fromJson(String)