public class Field34J extends Field implements java.io.Serializable, AmountContainer
String
String
Number
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.String |
F_34J
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 34J
|
static java.lang.String |
PARSER_PATTERN |
components
Constructor and Description |
---|
Field34J()
Default constructor
|
Field34J(java.lang.String value)
Creates the field parsing the parameter value into fields' components
|
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() |
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value
Shorthand for
new Tag(NAME, "") |
static Field34J |
get(SwiftMessage msg)
Get the first instance of Field34J in the given message.
|
static Field34J |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static java.util.List<Field34J> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field34J in the given message
an empty list is returned if none found.
|
static java.util.List<Field34J> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field34J 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.
|
java.lang.String |
getComponent2()
Get the component2
|
java.lang.String |
getComponent2AsString()
Deprecated.
|
java.lang.String |
getComponent3()
Get the component3
|
java.lang.Number |
getComponent3AsNumber()
Get the component3 as Number
|
java.lang.String |
getCurrency()
Get the Currency (component2).
|
java.lang.String |
getSign()
Get the Sign (component1).
|
java.lang.String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
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. |
java.lang.String |
parserPattern() |
Field34J |
setAmount(java.lang.Number component3)
Set the Amount (component3) as Number
|
Field34J |
setAmount(java.lang.String component3)
Set the Amount (component3).
|
Field34J |
setComponent1(java.lang.String component1)
Set the component1.
|
Field34J |
setComponent2(java.lang.String component2)
Set the component2.
|
Field34J |
setComponent3(java.lang.Number component3)
Set the component3.
|
Field34J |
setComponent3(java.lang.String component3)
Set the component3.
|
Field34J |
setCurrency(java.lang.String component2)
Set the Currency (component2).
|
Field34J |
setSign(java.lang.String component1)
Set the Sign (component1).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponents, getConditionalQualifier, getDSS, getField, getLabel, getLabel, getLabel, getLabel, getName, getValueByCodeword, getValueDisplay, hashCode, is, is, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toString
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.String F_34J
public static final java.lang.String NAME
public static final java.lang.String PARSER_PATTERN
public Field34J()
public Field34J(java.lang.String value)
value
- public java.math.BigDecimal amount()
AmountContainer
amount
in interface AmountContainer
public java.util.List<java.math.BigDecimal> amounts()
public java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public static Field34J get(SwiftMessage msg)
msg
- may be empty or null
public static Field34J get(SwiftTagListBlock block)
block
- may be null or emptypublic static java.util.List<Field34J> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returned
public static java.util.List<Field34J> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic java.lang.String getAmount()
public java.lang.Number getAmountAsNumber()
null
if cannot be convertedpublic java.lang.String getComponent1()
@Deprecated public java.lang.String getComponent1AsString()
public java.lang.String getComponent2()
@Deprecated public java.lang.String getComponent2AsString()
public java.lang.String getComponent3()
public java.lang.Number getComponent3AsNumber()
null
if cannot be convertedpublic java.lang.String getCurrency()
public java.lang.String getSign()
public java.lang.String getValue()
public boolean isGeneric()
public boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public Field34J setAmount(java.lang.Number component3)
component3
- Number with the Amount content to setpublic Field34J setAmount(java.lang.String component3)
component3
- the Amount to setpublic Field34J setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field34J setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field34J setComponent3(java.lang.Number component3)
component3
- the Number with the component3 content to setpublic Field34J setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field34J setCurrency(java.lang.String component2)
component2
- the Currency to setpublic Field34J setSign(java.lang.String component1)
component1
- the Sign to set