public class Field93C extends Field implements java.io.Serializable, AmountContainer, GenericField
String
String
String
String
Number
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.String |
F_93C
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 93C
|
static java.lang.String |
PARSER_PATTERN |
components
Constructor and Description |
---|
Field93C()
Default constructor
|
Field93C(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 Field93C |
get(SwiftMessage msg)
Get the first instance of Field93C in the given message.
|
static Field93C |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static java.util.List<Field93C> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field93C in the given message
an empty list is returned if none found.
|
static java.util.List<Field93C> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field93C from the given block
an empty list is returned if none found.
|
java.lang.String |
getAmount()
Get the Amount (component5).
|
java.lang.Number |
getAmountAsNumber()
Get the Amount (component5) 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.String |
getComponent3AsString()
Deprecated.
|
java.lang.String |
getComponent4()
Get the component4
|
java.lang.String |
getComponent4AsString()
Deprecated.
|
java.lang.String |
getComponent5()
Get the component5
|
java.lang.Number |
getComponent5AsNumber()
Get the component5 as Number
|
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()
Deprecated.
use constant Field93C
|
java.lang.String |
getQualifier()
Get the Qualifier (component1).
|
java.lang.String |
getSign()
Get the Sign (component4).
|
java.lang.String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
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. |
java.lang.String |
parserPattern() |
void |
setAmount(java.lang.Number component5)
Set the Amount (component5) as Number
|
void |
setAmount(java.lang.String component5)
Set the Amount (component5).
|
void |
setComponent1(java.lang.String component1)
Set the component1.
|
void |
setComponent2(java.lang.String component2)
Set the component2.
|
void |
setComponent3(java.lang.String component3)
Set the component3.
|
void |
setComponent4(java.lang.String component4)
Set the component4.
|
void |
setComponent5(java.lang.Number component5)
Set the component5.
|
void |
setComponent5(java.lang.String component5)
Set the component5.
|
void |
setQualifier(java.lang.String component1)
Set the Qualifier (component1).
|
void |
setSign(java.lang.String component4)
Set the Sign (component4).
|
appendInLines, appendInLines, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponents, getField, getLabel, getLabel, getLabel, getLabel, getValueByCodeword, getValueDisplay, hashCode, is, isAnyOf, isEmpty, isLetterOption, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toString
public static final java.lang.String NAME
public static final java.lang.String F_93C
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public Field93C()
public Field93C(java.lang.String value)
value
- public java.lang.String getValue()
public java.lang.String getComponent1()
@Deprecated public java.lang.String getComponent1AsString()
public java.lang.String getQualifier()
public void setComponent1(java.lang.String component1)
component1
- the component1 to setpublic void setQualifier(java.lang.String component1)
component1
- the Qualifier to setpublic java.lang.String getComponent2()
@Deprecated public java.lang.String getComponent2AsString()
public void setComponent2(java.lang.String component2)
component2
- the component2 to setpublic java.lang.String getComponent3()
@Deprecated public java.lang.String getComponent3AsString()
public void setComponent3(java.lang.String component3)
component3
- the component3 to setpublic java.lang.String getComponent4()
@Deprecated public java.lang.String getComponent4AsString()
public java.lang.String getSign()
public void setComponent4(java.lang.String component4)
component4
- the component4 to setpublic void setSign(java.lang.String component4)
component4
- the Sign to setpublic java.lang.String getComponent5()
public java.lang.Number getComponent5AsNumber()
null
if cannot be convertedpublic java.lang.String getAmount()
public java.lang.Number getAmountAsNumber()
null
if cannot be convertedpublic void setComponent5(java.lang.String component5)
component5
- the component5 to setpublic void setComponent5(java.lang.Number component5)
component5
- the Number with the component5 content to setpublic void setAmount(java.lang.String component5)
component5
- the Amount to setpublic void setAmount(java.lang.Number component5)
component5
- Number with the Amount content to setpublic java.util.List<java.math.BigDecimal> amounts()
public java.math.BigDecimal amount()
AmountContainer
amount
in interface AmountContainer
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 componentsPattern()
componentsPattern
in interface PatternContainer
public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public java.lang.String getName()
Field
public static Field93C get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field93C get(SwiftMessage msg)
msg
- may be empty or null
public static java.util.List<Field93C> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returned
public static java.util.List<Field93C> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returned