@Generated public class Field27 extends Field implements java.io.Serializable
Model and parser for field 27 of a SWIFT MT message.
Subfields (components) Data types
LongLongStructure definition
1n/1nS/SNNThis class complies with standard release SRU2021
| 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. |
components| 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.
|
| 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
|
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, validNamepublic static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_27
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String PARSER_PATTERN
parserPattern() method instead.@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String COMPONENTS_PATTERN
typesPattern() method instead.@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String TYPES_PATTERN
typesPattern() method instead.public static final java.lang.Integer NUMBER
public static final java.lang.Integer MESSAGE_NUMBER
NUMBERpublic static final java.lang.Integer TOTAL
public static final java.lang.Integer SEQUENCE_NUMBER
TOTALpublic Field27()
public Field27(java.lang.String value)
value - complete field value including separators and CRLFpublic Field27(Tag tag)
parse(String)java.lang.IllegalArgumentException - if the parameter tag is null or its tagname does not match the field namepublic static Field27 newInstance(Field27 source)
source - a field instance to copypublic static Tag tag(java.lang.String value)
new Tag(NAME, value)NAMEpublic static Tag emptyTag()
new Tag(NAME, "")NAMEpublic void parse(java.lang.String value)
Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
public java.lang.String getValue()
public java.lang.String getValueDisplay(int component,
java.util.Locale locale)
getValueDisplay in class Fieldcomponent - number of the component to displaylocale - optional locale to format date and amounts, if null, the default locale is usedjava.lang.IllegalArgumentException - if component number is invalid for the field@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.String componentsPattern()
typesPattern() instead.FieldtypesPattern() instead.componentsPattern in class FieldField.typesPattern()public java.lang.String typesPattern()
typesPattern in interface PatternContainertypesPattern in class Fieldpublic java.lang.String parserPattern()
parserPattern in interface PatternContainerpublic java.lang.String validatorPattern()
validatorPattern in class Fieldpublic boolean isOptional(int component)
isOptional in class Fieldcomponent - component number, first component of a field is referenced as 1public boolean isGeneric()
public int componentsSize()
componentsSize in class Fieldpublic java.util.List<java.lang.String> getComponentLabels()
getComponentLabels in class FieldField.getComponentLabel(int)protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
getComponentMap in class Fieldpublic java.lang.String getComponent1()
public java.lang.Long getComponent1AsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getComponent1AsNumber()
getComponent1AsLong() to get the proper value.getComponent1AsLong()public java.lang.String getNumber()
public java.lang.String getMessageNumber()
getNumber()public java.lang.Long getNumberAsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getNumberAsNumber()
getComponent1AsLong() to get the proper value.getNumberAsLong()public java.lang.Long getMessageNumberAsLong()
getNumberAsLong()@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getMessageNumberAsNumber()
getComponent1AsLong() to get the proper value.getNumberAsLong()public java.lang.String getComponent2()
public java.lang.Long getComponent2AsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getComponent2AsNumber()
getComponent2AsLong() to get the proper value.getComponent2AsLong()public java.lang.String getTotal()
public java.lang.String getSequenceNumber()
getTotal()public java.lang.Long getTotalAsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getTotalAsNumber()
getComponent2AsLong() to get the proper value.getTotalAsLong()public java.lang.Long getSequenceNumberAsLong()
getTotalAsLong()@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getSequenceNumberAsNumber()
getComponent2AsLong() to get the proper value.getTotalAsLong()public Field27 setComponent1(java.lang.String component1)
component1 - the Number to setpublic Field27 setComponent1(java.lang.Long component1)
component1 - the Long with the Number content to setsetComponent1(String)public Field27 setComponent1(java.lang.Number component1)
component1 - the Number with the Number content to setsetNumber(java.lang.Long)public Field27 setNumber(java.lang.String component1)
component1 - the Number to setpublic Field27 setNumber(java.lang.Long component1)
component1 - Long with the Number content to setsetComponent1(java.lang.Long)public Field27 setNumber(java.lang.Number component1)
component1 - the Number with the Number content to setsetNumber(java.lang.Long)public Field27 setMessageNumber(java.lang.String component1)
component1 - the Number to setsetNumber(String)public Field27 setMessageNumber(java.lang.Long component1)
component1 - Long with the Number content to setsetComponent1(java.lang.Long)public Field27 setMessageNumber(java.lang.Number component1)
component1 - the Number with the Number content to setsetNumber(java.lang.Long)public Field27 setComponent2(java.lang.String component2)
component2 - the Total to setpublic Field27 setComponent2(java.lang.Long component2)
component2 - the Long with the Total content to setsetComponent2(String)public Field27 setComponent2(java.lang.Number component2)
component2 - the Number with the Total content to setsetTotal(java.lang.Long)public Field27 setTotal(java.lang.String component2)
component2 - the Total to setpublic Field27 setTotal(java.lang.Long component2)
component2 - Long with the Total content to setsetComponent2(java.lang.Long)public Field27 setTotal(java.lang.Number component2)
component2 - the Number with the Total content to setsetTotal(java.lang.Long)public Field27 setSequenceNumber(java.lang.String component2)
component2 - the Total to setsetTotal(String)public Field27 setSequenceNumber(java.lang.Long component2)
component2 - Long with the Total content to setsetComponent2(java.lang.Long)public Field27 setSequenceNumber(java.lang.Number component2)
component2 - the Number with the Total content to setsetTotal(java.lang.Long)public java.lang.String getName()
public static Field27 get(SwiftTagListBlock block)
block - may be null or emptypublic static Field27 get(SwiftMessage msg)
msg - may be empty or nullget(SwiftTagListBlock)public static java.util.List<Field27> getAll(SwiftMessage msg)
msg - may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)public static java.util.List<Field27> getAll(SwiftTagListBlock block)
block - may be empty or null in which case an empty list is returnedpublic static Field27 fromJson(java.lang.String json)
json - JSON structure including tuples with label and value for all field componentsField.fromJson(String)