@Generated public class Field33K extends Field implements Serializable, CurrencyContainer, AmountContainer
String
Number
String
Currency
Number
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 |
DM_MARK
Component number for the D/M Mark subfield
|
static String |
F_33K
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 33K
|
static String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field33K()
Default constructor.
|
Field33K(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field33K(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 Field33K |
get(SwiftMessage msg)
Get the first instance of Field33K in the given message.
|
static Field33K |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field33K> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field33K in the given message
an empty list is returned if none found.
|
static List<Field33K> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field33K 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
|
String |
getComponent1AsString()
Deprecated.
|
String |
getComponent2()
Get the component2
|
Number |
getComponent2AsNumber()
Get the component2 as Number
|
String |
getComponent3()
Get the component3
|
String |
getComponent3AsString()
Deprecated.
|
String |
getComponent4()
Get the component4
|
Currency |
getComponent4AsCurrency()
Get the component4 as Currency
|
String |
getComponent5()
Get the component5
|
Number |
getComponent5AsNumber()
Get the component5 as Number
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getCurrency()
Get the Currency (component4).
|
Currency |
getCurrencyAsCurrency()
Get the Currency (component4) as Currency
|
String |
getDMMark()
Get the D/M Mark (component1).
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
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 Field33K |
newInstance(Field33K 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() |
Field33K |
setAmount(Number component5)
Set the Amount (component5) from a Number object.
|
Field33K |
setAmount(String component5)
Set the Amount (component5).
|
Field33K |
setComponent1(String component1)
Set the component1.
|
Field33K |
setComponent2(Number component2)
Set the component2 from a Number object.
|
Field33K |
setComponent2(String component2)
Set the component2.
|
Field33K |
setComponent3(String component3)
Set the component3.
|
Field33K |
setComponent4(Currency component4)
Set the component4 from a Currency object.
|
Field33K |
setComponent4(String component4)
Set the component4.
|
Field33K |
setComponent5(Number component5)
Set the component5 from a Number object.
|
Field33K |
setComponent5(String component5)
Set the component5.
|
Field33K |
setCurrency(Currency component4)
Set the Currency (component4) from a Currency object.
|
Field33K |
setCurrency(String component4)
Set the Currency (component4).
|
Field33K |
setDMMark(String component1)
Set the D/M Mark (component1).
|
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, 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_33K
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer DM_MARK
public static final Integer CURRENCY
public static final Integer AMOUNT
public Field33K()
public Field33K(String value)
value
- complete field value including separators and CRLFpublic Field33K(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 Field33K newInstance(Field33K 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 getDMMark()
public Field33K setComponent1(String component1)
component1
- the component1 to setpublic Field33K setDMMark(String component1)
component1
- the D/M Mark to setpublic String getComponent2()
public Number getComponent2AsNumber()
null
if cannot be convertedpublic Field33K setComponent2(String component2)
component2
- the component2 to setpublic Field33K setComponent2(Number component2)
component2
- the Number with the component2 content to setpublic String getComponent3()
@Deprecated public String getComponent3AsString()
public Field33K setComponent3(String component3)
component3
- the component3 to setpublic String getComponent4()
public Currency getComponent4AsCurrency()
null
if cannot be convertedpublic String getCurrency()
public Currency getCurrencyAsCurrency()
null
if cannot be convertedpublic Field33K setComponent4(String component4)
component4
- the component4 to setpublic Field33K setComponent4(Currency component4)
component4
- the Currency with the component4 content to setpublic Field33K setCurrency(String component4)
component4
- the Currency to setpublic Field33K setCurrency(Currency component4)
component4
- Currency with the Currency content to setsetComponent4(java.util.Currency)
public String getComponent5()
public Number getComponent5AsNumber()
null
if cannot be convertedpublic String getAmount()
public Number getAmountAsNumber()
null
if cannot be convertedpublic Field33K setComponent5(String component5)
component5
- the component5 to setpublic Field33K setComponent5(Number component5)
component5
- the Number with the component5 content to setpublic Field33K setAmount(String component5)
component5
- the Amount to setpublic Field33K setAmount(Number component5)
component5
- Number with the Amount content to setsetComponent5(java.lang.Number)
public 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 Field33K get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field33K get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field33K> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field33K> 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)