@Generated public class Field99A extends Field implements java.io.Serializable, AmountContainer, GenericField
String
String
Number
:4!c//[<N>]3!n
:S//[c]N
SSN
This class complies with standard release SRU2017
NOTE: this source code has been generated from template
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
AMOUNT
Component number for the Amount subfield
|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield
|
static java.lang.String |
F_99A
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 99A
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
QUALIFIER
Component number for the Qualifier subfield
|
static java.lang.Integer |
SIGN
Component number for the Sign subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field99A()
Default constructor.
|
Field99A(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field99A(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()
Get the first amount in this field.
|
java.util.List<java.math.BigDecimal> |
amounts() |
java.lang.String |
componentsPattern()
Returns the field's components pattern
|
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
Shorthand for
new Tag(NAME, "") |
static Field99A |
get(SwiftMessage msg)
Get the first instance of Field99A in the given message.
|
static Field99A |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static java.util.List<Field99A> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field99A in the given message
an empty list is returned if none found.
|
static java.util.List<Field99A> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field99A from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmount()
Get the Amount (component3).
|
java.lang.Number |
getAmountAsNumber()
Get the Amount (component3) as Number
|
java.lang.String |
getComponent1()
Get the component1
|
java.lang.String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent2()
Get the component2
|
java.lang.String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent3()
Get the component3
|
java.lang.Number |
getComponent3AsNumber()
Get the component3 as Number
|
protected java.util.List<java.lang.String> |
getComponentLabels()
Returns english label for components.
|
java.lang.String |
getConditionalQualifier()
Gets the conditional qualifier.
The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition. |
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()
Get the Qualifier (component1).
|
java.lang.String |
getSign()
Get the Sign (component2).
|
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 Field99A |
newInstance(Field99A source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
void |
parse(java.lang.String value)
Parses the parameter value into the internal components structure.
|
java.lang.String |
parserPattern() |
Field99A |
setAmount(java.lang.Number component3)
Set the Amount (component3) from a Number object.
|
Field99A |
setAmount(java.lang.String component3)
Set the Amount (component3).
|
Field99A |
setComponent1(java.lang.String component1)
Set the component1.
|
Field99A |
setComponent2(java.lang.String component2)
Set the component2.
|
Field99A |
setComponent3(java.lang.Number component3)
Set the component3 from a Number object.
|
Field99A |
setComponent3(java.lang.String component3)
Set the component3.
|
Field99A |
setQualifier(java.lang.String component1)
Set the Qualifier (component1).
|
Field99A |
setSign(java.lang.String component2)
Set the Sign (component2).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
java.lang.String |
validatorPattern()
Returns the field's validators pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isAnyOf, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_99A
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer QUALIFIER
public static final java.lang.Integer SIGN
public static final java.lang.Integer AMOUNT
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field99A()
public Field99A(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field99A(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic void parse(java.lang.String value)
public static Field99A newInstance(Field99A source)
source
- a field instance to copypublic java.lang.String getValue()
public static Tag tag(java.lang.String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public java.lang.String getComponent1()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent1AsString()
Field.getComponent(int)
insteadpublic java.lang.String getQualifier()
public Field99A setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field99A setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic java.lang.String getComponent2()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent2AsString()
Field.getComponent(int)
insteadpublic java.lang.String getSign()
public Field99A setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field99A setSign(java.lang.String component2)
component2
- the Sign to setpublic java.lang.String getComponent3()
public java.lang.Number getComponent3AsNumber()
null
if cannot be convertedpublic java.lang.String getAmount()
public java.lang.Number getAmountAsNumber()
null
if cannot be convertedpublic Field99A setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field99A setComponent3(java.lang.Number component3)
component3
- the Number with the component3 content to setpublic Field99A setAmount(java.lang.String component3)
component3
- the Amount to setpublic Field99A setAmount(java.lang.Number component3)
component3
- Number with the Amount content to setsetComponent3(java.lang.Number)
public java.util.List<java.math.BigDecimal> amounts()
AmountResolver.amounts(Field)
public java.math.BigDecimal amount()
AmountContainer
amount
in interface AmountContainer
AmountResolver.amount(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 java.lang.String getDSS()
getDSS
in interface GenericField
getDSS
in class Field
null
if the DSS is not set or not available for this field.public boolean isDSSPresent()
isDSSPresent
in interface GenericField
isDSSPresent
in class Field
getDSS()
public java.lang.String getConditionalQualifier()
getConditionalQualifier
in interface GenericField
getConditionalQualifier
in class Field
null
if not set or not applicable for this kind of field.public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public java.lang.String getName()
public final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final java.lang.String validatorPattern()
validatorPattern
in class Field
public static Field99A get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field99A get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field99A> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field99A> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field
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 fieldprotected java.util.List<java.lang.String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)