@Generated public class Field33B extends Field implements java.io.Serializable, AmountContainer
Model and parser for field 33B of a SWIFT MT message.
Subfields (components) Data types
String
BigDecimal
Structure definition
3!a<AMOUNT>15
SN
SN
This class complies with standard release SRU2022
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
AMOUNT
Component number for the Amount subfield.
|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() method instead. |
static java.lang.Integer |
CURRENCY
Component number for the Currency subfield.
|
static java.lang.String |
F_33B
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 33B.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static java.lang.Integer |
PRICE
Alternative constant name for field's Amount Component number.
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.String |
TYPES_PATTERN
Deprecated.
Use
typesPattern() method instead. |
components, labelMap
Constructor and Description |
---|
Field33B()
Default constructor.
|
Field33B(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field33B(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.
|
Modifier and Type | Method and Description |
---|---|
java.math.BigDecimal |
amount()
Returns the first amounts as BigDecimal
|
java.util.List<java.math.BigDecimal> |
amounts()
Returns the list of all NON-NULL amounts as BigDecimal
|
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 Field33B |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field33B object.
|
static Field33B |
get(SwiftMessage msg)
Gets the first instance of Field33B in the given message.
|
static Field33B |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field33B> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field33B in the given message
an empty list is returned if none found.
|
static java.util.List<Field33B> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field33B from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmount()
Gets the Amount (component 2).
|
java.math.BigDecimal |
getAmountAsBigDecimal()
Get the Amount (component 2) as BigDecimal
|
java.lang.Number |
getAmountAsNumber()
Deprecated.
|
java.lang.String |
getComponent1()
Gets the component 1 (Currency).
|
java.lang.String |
getComponent2()
Gets the component 2 (Amount).
|
java.math.BigDecimal |
getComponent2AsBigDecimal()
Get the component 2 as BigDecimal
|
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 |
getCurrency()
Gets the Currency (component 1).
|
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 |
getPrice()
Alternative method getter for field's Amount
|
java.math.BigDecimal |
getPriceAsBigDecimal()
Alternative method getter for field's Amount as BigDecimal
|
java.lang.Number |
getPriceAsNumber()
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 Field33B |
newInstance(Field33B 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.
|
Field33B |
setAmount(java.math.BigDecimal component2)
Set the Amount (component 2) from a BigDecimal object.
|
Field33B |
setAmount(java.lang.Number component2)
Alternative method setter for field's Amount (component 2) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field33B |
setAmount(java.lang.String component2)
Set the Amount (component 2).
|
Field33B |
setComponent1(java.lang.String component1)
Set the component 1 (Currency).
|
Field33B |
setComponent2(java.math.BigDecimal component2)
Set the component2 from a BigDecimal object.
|
Field33B |
setComponent2(java.lang.Number component2)
Alternative method setter for field's Amount (component 2) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
|
Field33B |
setComponent2(java.lang.String component2)
Set the component 2 (Amount).
|
Field33B |
setCurrency(java.lang.String component1)
Set the Currency (component 1).
|
Field33B |
setPrice(java.math.BigDecimal component2)
Alternative method setter for field's Amount from a BigDecimal object.
|
Field33B |
setPrice(java.lang.Number component2)
Alternative method setter for field's Amount (component 2) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field33B |
setPrice(java.lang.String component2)
Alternative method setter for field's Amount
|
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, 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
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_33B
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String PARSER_PATTERN
parserPattern()
method instead.@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
method instead.@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String TYPES_PATTERN
typesPattern()
method instead.public static final java.lang.Integer CURRENCY
public static final java.lang.Integer AMOUNT
public static final java.lang.Integer PRICE
AMOUNT
public Field33B()
public Field33B(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field33B(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field33B newInstance(Field33B source)
source
- a field instance to copypublic static Tag tag(java.lang.String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public 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 Field
component
- 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(phase3=SRU2023) public java.lang.String componentsPattern()
typesPattern()
instead.componentsPattern
in class Field
public java.lang.String typesPattern()
typesPattern
in interface PatternContainer
typesPattern
in class Field
public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public java.lang.String validatorPattern()
validatorPattern
in class Field
public boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public int componentsSize()
componentsSize
in class Field
public java.util.List<java.lang.String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
getComponentMap
in class Field
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Field
getLabelMap
in class Field
Field.getLabelMap()
public java.lang.String getComponent1()
public java.lang.String getCurrency()
public java.lang.String getComponent2()
public java.math.BigDecimal getComponent2AsBigDecimal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getComponent2AsNumber()
getComponent2AsBigDecimal()
to get the proper value.getComponent2AsBigDecimal()
public java.lang.String getAmount()
public java.lang.String getPrice()
getAmount()
public java.math.BigDecimal getAmountAsBigDecimal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getAmountAsNumber()
getComponent2AsBigDecimal()
to get the proper value.getAmountAsBigDecimal()
public java.math.BigDecimal getPriceAsBigDecimal()
getAmountAsBigDecimal()
@Deprecated @ProwideDeprecated(phase3=SRU2023) public java.lang.Number getPriceAsNumber()
getComponent2AsBigDecimal()
to get the proper value.getAmountAsBigDecimal()
public Field33B setComponent1(java.lang.String component1)
component1
- the Currency to setpublic Field33B setCurrency(java.lang.String component1)
component1
- the Currency to setpublic Field33B setComponent2(java.lang.String component2)
component2
- the Amount to setpublic Field33B setComponent2(java.math.BigDecimal component2)
component2
- the BigDecimal with the Amount content to setpublic Field33B setComponent2(java.lang.Number component2)
component2
- the Number with the Amount content to setsetAmount(java.math.BigDecimal)
public Field33B setAmount(java.lang.String component2)
component2
- the Amount to setpublic Field33B setAmount(java.math.BigDecimal component2)
component2
- BigDecimal with the Amount content to setsetComponent2(java.math.BigDecimal)
public Field33B setAmount(java.lang.Number component2)
component2
- the Number with the Amount content to setsetAmount(java.math.BigDecimal)
public Field33B setPrice(java.lang.String component2)
component2
- the Amount to setsetAmount(String)
public Field33B setPrice(java.math.BigDecimal component2)
component2
- BigDecimal with the Amount content to setsetComponent2(java.math.BigDecimal)
public Field33B setPrice(java.lang.Number component2)
component2
- the Number with the Amount content to setsetAmount(java.math.BigDecimal)
public java.util.List<java.math.BigDecimal> amounts()
AmountResolver.amounts(Field)
public java.math.BigDecimal amount()
amount
in interface AmountContainer
AmountResolver.amount(Field)
public java.lang.String getName()
public static Field33B get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field33B get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field33B> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field33B> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field33B fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)