@Generated public class Field92A extends Field implements java.io.Serializable, AmountContainer, GenericField
Model and parser for field 92A of a SWIFT MT message.
Subfields (components) Data types
String
String
BigDecimal
Structure definition
:4!c//[<N>]<AMOUNT>15
:S//[S]N
SSN
This 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.Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield.
|
static java.lang.String |
F_92A
Same as NAME, intended to be clear when using static imports.
|
static java.lang.String |
NAME
Constant with the field name 92A.
|
static java.lang.String |
PARSER_PATTERN
Deprecated.
Use
parserPattern() method instead. |
static java.lang.Integer |
QUALIFIER
Component number for the Qualifier subfield.
|
static java.lang.Integer |
RATE
Component number for the Rate subfield.
|
static java.lang.Integer |
RATE_AMOUNT
Deprecated.
|
static java.lang.Integer |
SIGN
Component number for the Sign subfield.
|
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
Constructor and Description |
---|
Field92A()
Default constructor.
|
Field92A(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field92A(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 Field92A |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field92A object.
|
static Field92A |
get(SwiftMessage msg)
Gets the first instance of Field92A in the given message.
|
static Field92A |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field92A> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field92A in the given message
an empty list is returned if none found.
|
static java.util.List<Field92A> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field92A from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (Qualifier).
|
java.lang.String |
getComponent2()
Gets the component 2 (Sign).
|
java.lang.String |
getComponent3()
Gets the component 3 (Rate).
|
java.math.BigDecimal |
getComponent3AsBigDecimal()
Get the component 3 as BigDecimal
|
java.lang.Number |
getComponent3AsNumber()
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 |
getConditionalQualifier()
Gets the component with the conditional (secondary) qualifier.
|
java.lang.String |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any).
|
java.lang.String |
getQualifier()
Gets the Qualifier (component 1).
|
java.lang.String |
getRate()
Gets the Rate (component 3).
|
java.lang.String |
getRateAmount()
Deprecated.
|
java.math.BigDecimal |
getRateAmountAsBigDecimal()
Deprecated.
|
java.lang.Number |
getRateAmountAsNumber()
Deprecated.
|
java.math.BigDecimal |
getRateAsBigDecimal()
Get the Rate (component 3) as BigDecimal
|
java.lang.Number |
getRateAsNumber()
Deprecated.
|
java.lang.String |
getSign()
Gets the Sign (component 2).
|
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 |
isDSSPresent()
Checks if the issuer code (or Data Source Scheme or DSS) is present.
|
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 Field92A |
newInstance(Field92A 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.
|
Field92A |
setComponent1(java.lang.String component1)
Set the component 1 (Qualifier).
|
Field92A |
setComponent2(java.lang.String component2)
Set the component 2 (Sign).
|
Field92A |
setComponent3(java.math.BigDecimal component3)
Set the component3 from a BigDecimal object.
|
Field92A |
setComponent3(java.lang.Number component3)
Alternative method setter for field's Rate (component 3) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
|
Field92A |
setComponent3(java.lang.String component3)
Set the component 3 (Rate).
|
Field92A |
setQualifier(java.lang.String component1)
Set the Qualifier (component 1).
|
Field92A |
setRate(java.math.BigDecimal component3)
Set the Rate (component 3) from a BigDecimal object.
|
Field92A |
setRate(java.lang.Number component3)
Alternative method setter for field's Rate (component 3) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field92A |
setRate(java.lang.String component3)
Set the Rate (component 3).
|
Field92A |
setRateAmount(java.math.BigDecimal component3)
Deprecated.
|
Field92A |
setRateAmount(java.lang.Number component3)
Deprecated.
|
Field92A |
setRateAmount(java.lang.String component3)
Deprecated.
|
Field92A |
setSign(java.lang.String component2)
Set the Sign (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, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_92A
@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 QUALIFIER
public static final java.lang.Integer SIGN
public static final java.lang.Integer RATE
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.Integer RATE_AMOUNT
RATE
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field92A()
public Field92A(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field92A(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field92A newInstance(Field92A 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(phase2=SRU2022) public java.lang.String componentsPattern()
typesPattern()
instead.Field
typesPattern()
instead.componentsPattern
in class Field
Field.typesPattern()
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
public java.lang.String getComponent1()
public java.lang.String getQualifier()
public java.lang.String getComponent2()
public java.lang.String getSign()
public java.lang.String getComponent3()
public java.math.BigDecimal getComponent3AsBigDecimal()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getComponent3AsNumber()
getComponent3AsBigDecimal()
to get the proper value.getComponent3AsBigDecimal()
public java.lang.String getRate()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.String getRateAmount()
getRate()
public java.math.BigDecimal getRateAsBigDecimal()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getRateAsNumber()
getComponent3AsBigDecimal()
to get the proper value.getRateAsBigDecimal()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.math.BigDecimal getRateAmountAsBigDecimal()
getRateAsBigDecimal()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getRateAmountAsNumber()
getComponent3AsBigDecimal()
to get the proper value.getRateAsBigDecimal()
public Field92A setComponent1(java.lang.String component1)
component1
- the Qualifier to setpublic Field92A setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic Field92A setComponent2(java.lang.String component2)
component2
- the Sign to setpublic Field92A setSign(java.lang.String component2)
component2
- the Sign to setpublic Field92A setComponent3(java.lang.String component3)
component3
- the Rate to setpublic Field92A setComponent3(java.math.BigDecimal component3)
component3
- the BigDecimal with the Rate content to setpublic Field92A setComponent3(java.lang.Number component3)
component3
- the Number with the Rate content to setsetRate(java.math.BigDecimal)
public Field92A setRate(java.lang.String component3)
component3
- the Rate to setpublic Field92A setRate(java.math.BigDecimal component3)
component3
- BigDecimal with the Rate content to setsetComponent3(java.math.BigDecimal)
public Field92A setRate(java.lang.Number component3)
component3
- the Number with the Rate content to setsetRate(java.math.BigDecimal)
@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field92A setRateAmount(java.lang.String component3)
component3
- the Rate to setsetRate(String)
@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field92A setRateAmount(java.math.BigDecimal component3)
component3
- BigDecimal with the Rate content to setsetComponent3(java.math.BigDecimal)
@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field92A setRateAmount(java.lang.Number component3)
component3
- the Number with the Rate content to setsetRate(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 getDSS()
getDSS
in interface GenericField
public boolean isDSSPresent()
isDSSPresent
in interface GenericField
getDSS()
public java.lang.String getConditionalQualifier()
getConditionalQualifier
in interface GenericField
public java.lang.String getName()
public static Field92A get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field92A get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field92A> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field92A> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic static Field92A fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)