@Generated public class Field68A extends Field implements Serializable, CurrencyContainer, AmountContainer
Number
Currency
Number
Number
Number
String
6n<CUR>6n/2n[/<AMOUNT>15][//10x]
NSN/N[/N][//S]
NCNNNS
This class complies with standard release SRU2017
NOTE: this source code has been generated from template
Modifier and Type | Field and Description |
---|---|
static Integer |
AMOUNT
Component number for the Amount subfield
|
static String |
COMPONENTS_PATTERN |
static Integer |
CURRENCY
Component number for the Currency subfield
|
static Integer |
DENOMINATION
Component number for the Denomination subfield
|
static String |
F_68A
same as NAME, intended to be clear when using static imports
|
static Integer |
MODE
Component number for the Mode subfield
|
static String |
NAME
Constant with the field name 68A
|
static Integer |
NUMBER
Component number for the Number subfield
|
static String |
PARSER_PATTERN |
static Integer |
PRODUCT_CODE
Component number for the Product Code subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field68A()
Default constructor.
|
Field68A(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field68A(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. |
List<Currency> |
currencies()
Utility method that creates a Currency for every string returned by
CurrencyContainer.currencyStrings() |
Currency |
currency()
Analog to
CurrencyContainer.currencyString() |
String |
currencyString()
Get the single currency contained in this field.
|
List<String> |
currencyStrings()
Get a list of strings of currencies present in this field
|
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value
Shorthand for
new Tag(NAME, "") |
static Field68A |
get(SwiftMessage msg)
Get the first instance of Field68A in the given message.
|
static Field68A |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field68A> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field68A in the given message
an empty list is returned if none found.
|
static List<Field68A> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field68A 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 |
getComponent1()
Get the component1
|
Number |
getComponent1AsNumber()
Get the component1 as Number
|
String |
getComponent2()
Get the component2
|
Currency |
getComponent2AsCurrency()
Get the component2 as Currency
|
String |
getComponent3()
Get the component3
|
Number |
getComponent3AsNumber()
Get the component3 as Number
|
String |
getComponent4()
Get the component4
|
Number |
getComponent4AsNumber()
Get the component4 as Number
|
String |
getComponent5()
Get the component5
|
Number |
getComponent5AsNumber()
Get the component5 as Number
|
String |
getComponent6()
Get the component6
|
String |
getComponent6AsString()
Deprecated.
use
Field.getComponent(int) instead |
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getCurrency()
Get the Currency (component2).
|
Currency |
getCurrencyAsCurrency()
Get the Currency (component2) as Currency
|
String |
getDenomination()
Get the Denomination (component3).
|
Number |
getDenominationAsNumber()
Get the Denomination (component3) as Number
|
String |
getMode()
Get the Mode (component4).
|
Number |
getModeAsNumber()
Get the Mode (component4) as Number
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getNumber()
Get the Number (component1).
|
Number |
getNumberAsNumber()
Get the Number (component1) as Number
|
String |
getProductCode()
Get the Product Code (component6).
|
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.
|
void |
initializeCurrencies(Currency cur) |
void |
initializeCurrencies(String cur)
set the currency of this field.
|
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 Field68A |
newInstance(Field68A 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() |
Field68A |
setAmount(Number component5)
Set the Amount (component5) from a Number object.
|
Field68A |
setAmount(String component5)
Set the Amount (component5).
|
Field68A |
setComponent1(Number component1)
Set the component1 from a Number object.
|
Field68A |
setComponent1(String component1)
Set the component1.
|
Field68A |
setComponent2(Currency component2)
Set the component2 from a Currency object.
|
Field68A |
setComponent2(String component2)
Set the component2.
|
Field68A |
setComponent3(Number component3)
Set the component3 from a Number object.
|
Field68A |
setComponent3(String component3)
Set the component3.
|
Field68A |
setComponent4(Number component4)
Set the component4 from a Number object.
|
Field68A |
setComponent4(String component4)
Set the component4.
|
Field68A |
setComponent5(Number component5)
Set the component5 from a Number object.
|
Field68A |
setComponent5(String component5)
Set the component5.
|
Field68A |
setComponent6(String component6)
Set the component6.
|
Field68A |
setCurrency(Currency component2)
Set the Currency (component2) from a Currency object.
|
Field68A |
setCurrency(String component2)
Set the Currency (component2).
|
Field68A |
setDenomination(Number component3)
Set the Denomination (component3) from a Number object.
|
Field68A |
setDenomination(String component3)
Set the Denomination (component3).
|
Field68A |
setMode(Number component4)
Set the Mode (component4) from a Number object.
|
Field68A |
setMode(String component4)
Set the Mode (component4).
|
Field68A |
setNumber(Number component1)
Set the Number (component1) from a Number object.
|
Field68A |
setNumber(String component1)
Set the Number (component1).
|
Field68A |
setProductCode(String component6)
Set the Product Code (component6).
|
static Tag |
tag(String value)
Create a Tag with this field name and the given value.
|
String |
validatorPattern()
Returns the field's validators pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toString, validName
public static final int SRU
public static final String NAME
public static final String F_68A
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer NUMBER
public static final Integer CURRENCY
public static final Integer DENOMINATION
public static final Integer MODE
public static final Integer AMOUNT
public static final Integer PRODUCT_CODE
public Field68A()
public Field68A(String value)
value
- complete field value including separators and CRLFpublic Field68A(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 Field68A newInstance(Field68A 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()
public Number getComponent1AsNumber()
null
if cannot be convertedpublic String getNumber()
public Number getNumberAsNumber()
null
if cannot be convertedpublic Field68A setComponent1(String component1)
component1
- the component1 to setpublic Field68A setComponent1(Number component1)
component1
- the Number with the component1 content to setpublic Field68A setNumber(String component1)
component1
- the Number to setpublic Field68A setNumber(Number component1)
component1
- Number with the Number content to setsetComponent1(java.lang.Number)
public String getComponent2()
public Currency getComponent2AsCurrency()
null
if cannot be convertedpublic String getCurrency()
public Currency getCurrencyAsCurrency()
null
if cannot be convertedpublic Field68A setComponent2(String component2)
component2
- the component2 to setpublic Field68A setComponent2(Currency component2)
component2
- the Currency with the component2 content to setpublic Field68A setCurrency(String component2)
component2
- the Currency to setpublic Field68A setCurrency(Currency component2)
component2
- Currency with the Currency content to setsetComponent2(java.util.Currency)
public String getComponent3()
public Number getComponent3AsNumber()
null
if cannot be convertedpublic String getDenomination()
public Number getDenominationAsNumber()
null
if cannot be convertedpublic Field68A setComponent3(String component3)
component3
- the component3 to setpublic Field68A setComponent3(Number component3)
component3
- the Number with the component3 content to setpublic Field68A setDenomination(String component3)
component3
- the Denomination to setpublic Field68A setDenomination(Number component3)
component3
- Number with the Denomination content to setsetComponent3(java.lang.Number)
public String getComponent4()
public Number getComponent4AsNumber()
null
if cannot be convertedpublic String getMode()
public Number getModeAsNumber()
null
if cannot be convertedpublic Field68A setComponent4(String component4)
component4
- the component4 to setpublic Field68A setComponent4(Number component4)
component4
- the Number with the component4 content to setpublic Field68A setMode(String component4)
component4
- the Mode to setpublic Field68A setMode(Number component4)
component4
- Number with the Mode content to setsetComponent4(java.lang.Number)
public String getComponent5()
public Number getComponent5AsNumber()
null
if cannot be convertedpublic String getAmount()
public Number getAmountAsNumber()
null
if cannot be convertedpublic Field68A setComponent5(String component5)
component5
- the component5 to setpublic Field68A setComponent5(Number component5)
component5
- the Number with the component5 content to setpublic Field68A setAmount(String component5)
component5
- the Amount to setpublic Field68A setAmount(Number component5)
component5
- Number with the Amount content to setsetComponent5(java.lang.Number)
public String getComponent6()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent6AsString()
Field.getComponent(int)
insteadpublic String getProductCode()
public Field68A setComponent6(String component6)
component6
- the component6 to setpublic Field68A setProductCode(String component6)
component6
- the Product Code to setpublic List<String> currencyStrings()
CurrencyContainer
currencyStrings
in interface CurrencyContainer
public List<Currency> currencies()
CurrencyContainer
CurrencyContainer.currencyStrings()
currencies
in interface CurrencyContainer
public Currency currency()
CurrencyContainer
CurrencyContainer.currencyString()
currency
in interface CurrencyContainer
CurrencyContainer.currencyStrings()
,
CurrencyContainer.currencyString()
public String currencyString()
CurrencyContainer
currencyString
in interface CurrencyContainer
public void initializeCurrencies(String cur)
CurrencyContainer
initializeCurrencies
in interface CurrencyContainer
public void initializeCurrencies(Currency cur)
initializeCurrencies
in interface CurrencyContainer
CurrencyContainer.initializeCurrencies(String)
public List<BigDecimal> amounts()
AmountResolver.amounts(Field)
public BigDecimal amount()
AmountContainer
amount
in interface AmountContainer
AmountResolver.amount(Field)
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 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 Field68A get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field68A get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field68A> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field68A> 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)