@Generated public class Field93B extends Field implements Serializable, AmountContainer, GenericField
String
String
String
String
Number
Modifier and Type | Field and Description |
---|---|
static Integer |
BALANCE_AMOUNT
Component number for the Balance Amount subfield
|
static String |
COMPONENTS_PATTERN |
static Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield
|
static Integer |
DATA_SOURCE_SCHEME
Component number for the Data Source Scheme subfield
|
static String |
F_93B
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 93B
|
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
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field93B()
Default constructor.
|
Field93B(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field93B(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.
|
Modifier and Type | Method and Description |
---|---|
BigDecimal |
amount()
Get the first amount in this field.
|
List<BigDecimal> |
amounts() |
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 Field93B |
get(SwiftMessage msg)
Get the first instance of Field93B in the given message.
|
static Field93B |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field93B> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field93B in the given message
an empty list is returned if none found.
|
static List<Field93B> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field93B from the given block
an empty list is returned if none found.
|
String |
getBalanceAmount()
Get the Balance Amount (component5).
|
Number |
getBalanceAmountAsNumber()
Get the Balance Amount (component5) as Number
|
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
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
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 |
getDataSourceScheme()
Get the Data Source Scheme (component2).
|
String |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getQualifier()
Get the Qualifier (component1).
|
String |
getQuantityTypeCode()
Get the Quantity Type Code (component3).
|
String |
getSign()
Get the Sign (component4).
|
String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
String |
getValueDisplay(int component,
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 Field93B |
newInstance(Field93B source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
void |
parse(String value)
Parses the parameter value into the internal components structure.
|
String |
parserPattern() |
Field93B |
setBalanceAmount(Number component5)
Set the Balance Amount (component5) from a Number object.
|
Field93B |
setBalanceAmount(String component5)
Set the Balance Amount (component5).
|
Field93B |
setComponent1(String component1)
Set the component1.
|
Field93B |
setComponent2(String component2)
Set the component2.
|
Field93B |
setComponent3(String component3)
Set the component3.
|
Field93B |
setComponent4(String component4)
Set the component4.
|
Field93B |
setComponent5(Number component5)
Set the component5 from a Number object.
|
Field93B |
setComponent5(String component5)
Set the component5.
|
Field93B |
setDataSourceScheme(String component2)
Set the Data Source Scheme (component2).
|
Field93B |
setQualifier(String component1)
Set the Qualifier (component1).
|
Field93B |
setQuantityTypeCode(String component3)
Set the Quantity Type Code (component3).
|
Field93B |
setSign(String component4)
Set the Sign (component4).
|
static Tag |
tag(String value)
Create a Tag with this field name and the given value.
|
String |
validatorPattern()
Returns the field's validators pattern
|
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, isAnyOf, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toString, validName
public static final int SRU
public static final String NAME
public static final String F_93B
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer QUALIFIER
public static final Integer DATA_SOURCE_SCHEME
public static final Integer QUANTITY_TYPE_CODE
public static final Integer SIGN
public static final Integer BALANCE_AMOUNT
public static final Integer CONDITIONAL_QUALIFIER
public Field93B()
public Field93B(String value)
value
- complete field value including separators and CRLFpublic Field93B(Tag tag)
parse(String)
IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic void parse(String value)
public static Field93B newInstance(Field93B 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 Field93B setComponent1(String component1)
component1
- the component1 to setpublic Field93B setQualifier(String component1)
component1
- the Qualifier to setpublic String getComponent2()
@Deprecated public String getComponent2AsString()
public String getDataSourceScheme()
public Field93B setComponent2(String component2)
component2
- the component2 to setpublic Field93B setDataSourceScheme(String component2)
component2
- the Data Source Scheme to setpublic String getComponent3()
@Deprecated public String getComponent3AsString()
public String getQuantityTypeCode()
public Field93B setComponent3(String component3)
component3
- the component3 to setpublic Field93B setQuantityTypeCode(String component3)
component3
- the Quantity Type Code to setpublic String getComponent4()
@Deprecated public String getComponent4AsString()
public String getSign()
public Field93B setComponent4(String component4)
component4
- the component4 to setpublic Field93B setSign(String component4)
component4
- the Sign to setpublic String getComponent5()
public Number getComponent5AsNumber()
null
if cannot be convertedpublic String getBalanceAmount()
public Number getBalanceAmountAsNumber()
null
if cannot be convertedpublic Field93B setComponent5(String component5)
component5
- the component5 to setpublic Field93B setComponent5(Number component5)
component5
- the Number with the component5 content to setpublic Field93B setBalanceAmount(String component5)
component5
- the Balance Amount to setpublic Field93B setBalanceAmount(Number component5)
component5
- Number with the Balance Amount content to setsetComponent5(java.lang.Number)
public 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 parserPattern()
parserPattern
in interface PatternContainer
public String getName()
public final String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final String validatorPattern()
validatorPattern
in class Field
public static Field93B get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field93B get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field93B> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field93B> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field
public String getValueDisplay(int component, 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 usedIllegalArgumentException
- if component number is invalid for the fieldprotected List<String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)