public class Field13A extends Field implements java.io.Serializable, GenericField
String
String
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.String |
F_13A
same as NAME, intended to be clear when using static imports
|
static java.lang.String |
NAME
Constant with the field name 13A
|
static java.lang.String |
PARSER_PATTERN |
components
Constructor and Description |
---|
Field13A()
Default constructor
|
Field13A(java.lang.String value)
Creates the field parsing the parameter value into fields' components
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
componentsPattern() |
static Field13A |
get(SwiftMessage msg)
Get the first instance of Field13A in the given message.
|
static Field13A |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static java.util.List<Field13A> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field13A in the given message
an empty list is returned if none found.
|
static java.util.List<Field13A> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field13A from the given block
an empty list is returned if none found.
|
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 |
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 Field13A
|
java.lang.String |
getNumberId()
Get the Number Id (component2).
|
java.lang.String |
getQualifier()
Get the Qualifier (component1).
|
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 |
setComponent1(java.lang.String component1)
Set the component1.
|
void |
setComponent2(java.lang.String component2)
Set the component2.
|
void |
setNumberId(java.lang.String component2)
Set the Number Id (component2).
|
void |
setQualifier(java.lang.String component1)
Set the Qualifier (component1).
|
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_13A
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public Field13A()
public Field13A(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 java.lang.String getNumberId()
public void setComponent2(java.lang.String component2)
component2
- the component2 to setpublic void setNumberId(java.lang.String component2)
component2
- the Number Id to setpublic 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 Field13A get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field13A get(SwiftMessage msg)
msg
- may be empty or null
public static java.util.List<Field13A> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returned
public static java.util.List<Field13A> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returned