Class Field19Y
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.Field19Y
-
- All Implemented Interfaces:
JsonSerializable
,AmountContainer
,PatternContainer
,java.io.Serializable
@Generated public class Field19Y extends Field implements java.io.Serializable, AmountContainer
SWIFT MT Field 19Y.Model and parser for field 19Y of a SWIFT MT message.
Subfields (components) Data types
- Component 1: Weight:
BigDecimal
Structure definition
- validation pattern:
<AMOUNT>15
- parser pattern:
N
- components pattern:
N
This class complies with standard release SRU2023
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.Integer
AMOUNT
Deprecated.use #WEIGHT insteadstatic java.lang.String
COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.static java.lang.String
F_19Y
Same as NAME, intended to be clear when using static imports.static java.lang.String
NAME
Constant with the field name 19Y.static java.lang.String
PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.static int
SRU
Constant identifying the SRU to which this class belongs to.static java.lang.String
TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.static java.lang.Integer
WEIGHT
Component number for the Weight subfield.-
Fields inherited from class com.prowidesoftware.swift.model.field.Field
components, labelMap
-
-
Constructor Summary
Constructors Constructor Description Field19Y()
Default constructor.Field19Y(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field19Y(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.math.BigDecimal
amount()
Returns the first amounts as BigDecimaljava.util.List<java.math.BigDecimal>
amounts()
Returns the list of all NON-NULL amounts as BigDecimaljava.lang.String
componentsPattern()
Deprecated.UsetypesPattern()
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 Field19Y
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field19Y object.static Field19Y
get(SwiftMessage msg)
Gets the first instance of Field19Y in the given message.static Field19Y
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.static java.util.List<Field19Y>
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field19Y in the given message an empty list is returned if none found.static java.util.List<Field19Y>
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field19Y from the given block an empty list is returned if none found.java.lang.String
getAmount()
Deprecated.use #getWeight() insteadjava.math.BigDecimal
getAmountAsBigDecimal()
Deprecated.use #getWeightAsBigDecimal() insteadjava.lang.Number
getAmountAsNumber()
Deprecated.use #getWeightAsBigDecimal() insteadjava.lang.String
getComponent1()
Gets the component 1 (Weight).java.math.BigDecimal
getComponent1AsBigDecimal()
Get the component 1 as BigDecimaljava.lang.Number
getComponent1AsNumber()
Deprecated.use #getComponent1AsBigDecimal() insteadjava.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.protected java.util.Map<java.lang.String,java.lang.Integer>
getLabelMap()
Returns a mapping between component labels and the internal component number.java.lang.String
getName()
Returns the field's name composed by the field number and the letter option (if any).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.java.lang.String
getWeight()
Gets the Weight (component 1).java.math.BigDecimal
getWeightAsBigDecimal()
Get the Weight (component 1) as BigDecimaljava.lang.Number
getWeightAsNumber()
Deprecated.use #getWeightAsBigDecimal() insteadboolean
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 Field19Y
newInstance(Field19Y 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.Field19Y
setAmount(java.lang.Number component1)
Deprecated.use #setWeight(java.math.BigDecimal) insteadField19Y
setAmount(java.lang.String component1)
Deprecated.use #setWeight(String) insteadField19Y
setAmount(java.math.BigDecimal component1)
Deprecated.use #setComponent1(java.math.BigDecimal) insteadField19Y
setComponent1(java.lang.Number component1)
Alternative method setter for field's Weight (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)Field19Y
setComponent1(java.lang.String component1)
Set the component 1 (Weight).Field19Y
setComponent1(java.math.BigDecimal component1)
Set the component1 from a BigDecimal object.Field19Y
setWeight(java.lang.Number component1)
Alternative method setter for field's Weight (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)Field19Y
setWeight(java.lang.String component1)
Set the Weight (component 1).Field19Y
setWeight(java.math.BigDecimal component1)
Set the Weight (component 1) from a BigDecimal object.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, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponent, getComponentAs, getComponentAs, getComponentAsNumber, getComponentAsNumber, getComponentLabel, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponent, setComponents, toJson, toString, validName
-
-
-
-
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 19Y.- See Also:
- Constant Field Values
-
F_19Y
public static final java.lang.String F_19Y
Same as NAME, intended to be clear when using static imports.- See Also:
- Constant Field Values
-
PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.- See Also:
- Constant Field Values
-
COMPONENTS_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
TYPES_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
WEIGHT
public static final java.lang.Integer WEIGHT
Component number for the Weight subfield.
-
AMOUNT
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.Integer AMOUNT
Deprecated.use #WEIGHT instead
-
-
Constructor Detail
-
Field19Y
public Field19Y()
Default constructor. Creates a new field setting all components to null.
-
Field19Y
public Field19Y(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
-
Field19Y
public Field19Y(Tag tag)
Creates a new field and initializes its components with content from the parameter tag. The value is parsed withparse(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 Field19Y newInstance(Field19Y 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 fornew 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 fornew 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.
-
getValue
public java.lang.String getValue()
Serializes the fields' components into the single string value (SWIFT format)
-
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 classField
- Parameters:
component
- number of the component to displaylocale
- 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(phase4=SRU2024) public java.lang.String componentsPattern()
Deprecated.UsetypesPattern()
instead.- Specified by:
componentsPattern
in classField
-
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 interfacePatternContainer
- Specified by:
typesPattern
in classField
- Since:
- 9.2.7
-
parserPattern
public java.lang.String parserPattern()
Returns the field parser pattern.- Specified by:
parserPattern
in interfacePatternContainer
-
validatorPattern
public java.lang.String validatorPattern()
Returns the field validator pattern- Specified by:
validatorPattern
in classField
-
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 classField
- 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.
-
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 classField
- 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 classField
- 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 classField
- Since:
- 7.10.3
-
getLabelMap
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Description copied from class:Field
Returns a mapping between component labels and the internal component number. Component labels are in lowercase and without spaces and separators. If a for a given component there is more than one label option, both are mapped to the same component number.- Specified by:
getLabelMap
in classField
- Since:
- 9.3.12
- See Also:
Field.getLabelMap()
-
getComponent1
public java.lang.String getComponent1()
Gets the component 1 (Weight).- Returns:
- the component 1
-
getComponent1AsBigDecimal
public java.math.BigDecimal getComponent1AsBigDecimal()
Get the component 1 as BigDecimal- Returns:
- the component 1 converted to BigDecimal or null if cannot be converted
- Since:
- 9.2.7
-
getComponent1AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent1AsNumber()
Deprecated.use #getComponent1AsBigDecimal() instead
-
getWeight
public java.lang.String getWeight()
Gets the Weight (component 1).- Returns:
- the Weight from component 1
-
getAmount
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String getAmount()
Deprecated.use #getWeight() insteadAlternative DEPRECATED method getter for field's Weight- Since:
- 9.2.7
-
getWeightAsBigDecimal
public java.math.BigDecimal getWeightAsBigDecimal()
Get the Weight (component 1) as BigDecimal- Returns:
- the Weight from component 1 converted to BigDecimal or null if cannot be converted
- Since:
- 9.2.7
-
getWeightAsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getWeightAsNumber()
Deprecated.use #getWeightAsBigDecimal() instead
-
getAmountAsBigDecimal
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.math.BigDecimal getAmountAsBigDecimal()
Deprecated.use #getWeightAsBigDecimal() instead
-
getAmountAsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getAmountAsNumber()
Deprecated.use #getWeightAsBigDecimal() instead
-
setComponent1
public Field19Y setComponent1(java.lang.String component1)
Set the component 1 (Weight).- Parameters:
component1
- the Weight to set- Returns:
- the field object to enable build pattern
-
setComponent1
public Field19Y setComponent1(java.math.BigDecimal component1)
Set the component1 from a BigDecimal object.
Parses the BigDecimal into a SWIFT amount with truncated zero decimals and mandatory decimal separator.- Example: 1234.00 -> 1234,
- Example: 1234 -> 1234,
- Example: 1234.56 -> 1234,56
- Parameters:
component1
- the BigDecimal with the Weight content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
-
setComponent1
public Field19Y setComponent1(java.lang.Number component1)
Alternative method setter for field's Weight (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)- Parameters:
component1
- the Number with the Weight content to set- Returns:
- the field object to enable build pattern
- See Also:
setWeight(java.math.BigDecimal)
-
setWeight
public Field19Y setWeight(java.lang.String component1)
Set the Weight (component 1).- Parameters:
component1
- the Weight to set- Returns:
- the field object to enable build pattern
-
setWeight
public Field19Y setWeight(java.math.BigDecimal component1)
Set the Weight (component 1) from a BigDecimal object.- Parameters:
component1
- BigDecimal with the Weight content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent1(java.math.BigDecimal)
-
setWeight
public Field19Y setWeight(java.lang.Number component1)
Alternative method setter for field's Weight (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 Weight content to set- Returns:
- the field object to enable build pattern
- See Also:
setWeight(java.math.BigDecimal)
-
setAmount
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field19Y setAmount(java.lang.String component1)
Deprecated.use #setWeight(String) instead
-
setAmount
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field19Y setAmount(java.math.BigDecimal component1)
Deprecated.use #setComponent1(java.math.BigDecimal) instead- Since:
- 9.2.7
-
setAmount
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field19Y setAmount(java.lang.Number component1)
Deprecated.use #setWeight(java.math.BigDecimal) instead
-
amounts
public java.util.List<java.math.BigDecimal> amounts()
Returns the list of all NON-NULL amounts as BigDecimal- Returns:
- the list of NON-NULL amounts as BigDecimal values
- See Also:
AmountResolver.amounts(Field)
-
amount
public java.math.BigDecimal amount()
Returns the first amounts as BigDecimal- Specified by:
amount
in interfaceAmountContainer
- Returns:
- the first amount as BigDecimal value. Can be null
- See Also:
AmountResolver.amount(Field)
-
getName
public java.lang.String getName()
Returns the field's name composed by the field number and the letter option (if any).
-
get
public static Field19Y 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 Field19Y get(SwiftMessage msg)
Gets the first instance of Field19Y 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<Field19Y> getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field19Y 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<Field19Y> getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field19Y 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 Field19Y fromJson(java.lang.String json)
This method deserializes the JSON data into a Field19Y 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)
-
-