public class Field93C extends Field implements Serializable, AmountContainer, GenericField
String
String
String
String
Number
Modifier and Type | Field and Description |
---|---|
static Integer |
AMOUNT
Component number for the Amount subfield
|
static Integer |
BALANCE_TYPE_CODE
Component number for the Balance Type Code subfield
|
static String |
COMPONENTS_PATTERN |
static String |
F_93C
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 93C
|
static String |
PARSER_PATTERN |
static Integer |
QUALIFIER
Component number for the Qualifier subfield
|
static Integer |
QUANTITY_TYPE_CODE
Component number for the Quantity Type Code subfield
|
static Integer |
SIGN
Component number for the Sign subfield
|
components
Constructor and Description |
---|
Field93C()
Default constructor
|
Field93C(String value)
Creates the field parsing the parameter value into fields' components
|
Modifier and Type | Method and Description |
---|---|
BigDecimal |
amount()
Get the first amount in this field.
|
List<BigDecimal> |
amounts() |
String |
componentsPattern() |
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 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 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 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.
|
String |
getAmount()
Get the Amount (component5).
|
Number |
getAmountAsNumber()
Get the Amount (component5) as Number
|
String |
getBalanceTypeCode()
Get the Balance Type Code (component3).
|
String |
getComponent1()
Get the component1
|
String |
getComponent1AsString()
Deprecated.
|
String |
getComponent2()
Get the component2
|
String |
getComponent2AsString()
Deprecated.
|
String |
getComponent3()
Get the component3
|
String |
getComponent3AsString()
Deprecated.
|
String |
getComponent4()
Get the component4
|
String |
getComponent4AsString()
Deprecated.
|
String |
getComponent5()
Get the component5
|
Number |
getComponent5AsNumber()
Get the component5 as Number
|
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. |
String |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
String |
getName()
Deprecated.
use constant Field93C
|
String |
getQualifier()
Get the Qualifier (component1).
|
String |
getQuantityTypeCode()
Get the Quantity Type Code (component2).
|
String |
getSign()
Get the Sign (component4).
|
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. |
static Field93C |
newInstance(Field93C source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
String |
parserPattern() |
Field93C |
setAmount(Number component5)
Set the Amount (component5) as Number
|
Field93C |
setAmount(String component5)
Set the Amount (component5).
|
Field93C |
setBalanceTypeCode(String component3)
Set the Balance Type Code (component3).
|
Field93C |
setComponent1(String component1)
Set the component1.
|
Field93C |
setComponent2(String component2)
Set the component2.
|
Field93C |
setComponent3(String component3)
Set the component3.
|
Field93C |
setComponent4(String component4)
Set the component4.
|
Field93C |
setComponent5(Number component5)
Set the component5.
|
Field93C |
setComponent5(String component5)
Set the component5.
|
Field93C |
setQualifier(String component1)
Set the Qualifier (component1).
|
Field93C |
setQuantityTypeCode(String component2)
Set the Quantity Type Code (component2).
|
Field93C |
setSign(String component4)
Set the Sign (component4).
|
static Tag |
tag(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, getField, getLabel, getLabel, getLabel, getLabel, getLine, getValueByCodeword, getValueDisplay, hashCode, is, is, is, isAnyOf, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toString
public static final String NAME
public static final String F_93C
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer QUALIFIER
public static final Integer QUANTITY_TYPE_CODE
public static final Integer BALANCE_TYPE_CODE
public static final Integer SIGN
public static final Integer AMOUNT
public Field93C()
public Field93C(String value)
value
- public static Field93C newInstance(Field93C source)
source
- a field instance to copypublic String getValue()
public static Tag tag(String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public String getComponent1()
@Deprecated public String getComponent1AsString()
public String getQualifier()
public Field93C setComponent1(String component1)
component1
- the component1 to setpublic Field93C setQualifier(String component1)
component1
- the Qualifier to setpublic String getComponent2()
@Deprecated public String getComponent2AsString()
public String getQuantityTypeCode()
public Field93C setComponent2(String component2)
component2
- the component2 to setpublic Field93C setQuantityTypeCode(String component2)
component2
- the Quantity Type Code to setpublic String getComponent3()
@Deprecated public String getComponent3AsString()
public String getBalanceTypeCode()
public Field93C setComponent3(String component3)
component3
- the component3 to setpublic Field93C setBalanceTypeCode(String component3)
component3
- the Balance Type Code to setpublic String getComponent4()
@Deprecated public String getComponent4AsString()
public String getSign()
public Field93C setComponent4(String component4)
component4
- the component4 to setpublic Field93C setSign(String component4)
component4
- the Sign to setpublic String getComponent5()
public Number getComponent5AsNumber()
null
if cannot be convertedpublic String getAmount()
public Number getAmountAsNumber()
null
if cannot be convertedpublic Field93C setComponent5(String component5)
component5
- the component5 to setpublic Field93C setComponent5(Number component5)
component5
- the Number with the component5 content to setpublic Field93C setAmount(String component5)
component5
- the Amount to setpublic Field93C setAmount(Number component5)
component5
- Number with the Amount content to setpublic List<BigDecimal> amounts()
public 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 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 String getConditionalQualifier()
getConditionalQualifier
in interface GenericField
getConditionalQualifier
in class Field
null
if not set or not applicable for this kind of field.public String componentsPattern()
componentsPattern
in interface PatternContainer
public String parserPattern()
parserPattern
in interface PatternContainer
public 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 nullget(SwiftTagListBlock)
public static List<Field93C> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field93C> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field