@Generated public class Field39P extends Field implements Serializable, CurrencyContainer, AmountContainer
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 String |
F_39P
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 39P
|
static String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field39P()
Default constructor.
|
Field39P(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field39P(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 Field39P |
get(SwiftMessage msg)
Get the first instance of Field39P in the given message.
|
static Field39P |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field39P> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field39P in the given message
an empty list is returned if none found.
|
static List<Field39P> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field39P from the given block
an empty list is returned if none found.
|
String |
getAmount()
Get the Amount (component3).
|
Number |
getAmountAsNumber()
Get the Amount (component3) as Number
|
String |
getComponent1()
Get the component1
|
String |
getComponent1AsString()
Deprecated.
|
String |
getComponent2()
Get the component2
|
Currency |
getComponent2AsCurrency()
Get the component2 as Currency
|
String |
getComponent3()
Get the component3
|
Number |
getComponent3AsNumber()
Get the component3 as Number
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getCurrency()
Get the Currency (component2).
|
Currency |
getCurrencyAsCurrency()
Get the Currency (component2) as Currency
|
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 Field39P |
newInstance(Field39P 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() |
Field39P |
setAmount(Number component3)
Set the Amount (component3) from a Number object.
|
Field39P |
setAmount(String component3)
Set the Amount (component3).
|
Field39P |
setComponent1(String component1)
Set the component1.
|
Field39P |
setComponent2(Currency component2)
Set the component2 from a Currency object.
|
Field39P |
setComponent2(String component2)
Set the component2.
|
Field39P |
setComponent3(Number component3)
Set the component3 from a Number object.
|
Field39P |
setComponent3(String component3)
Set the component3.
|
Field39P |
setCurrency(Currency component2)
Set the Currency (component2) from a Currency object.
|
Field39P |
setCurrency(String component2)
Set the Currency (component2).
|
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_39P
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer CURRENCY
public static final Integer AMOUNT
public Field39P()
public Field39P(String value)
value
- complete field value including separators and CRLFpublic Field39P(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 Field39P newInstance(Field39P 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 Field39P setComponent1(String component1)
component1
- the component1 to setpublic String getComponent2()
public Currency getComponent2AsCurrency()
null
if cannot be convertedpublic String getCurrency()
public Currency getCurrencyAsCurrency()
null
if cannot be convertedpublic Field39P setComponent2(String component2)
component2
- the component2 to setpublic Field39P setComponent2(Currency component2)
component2
- the Currency with the component2 content to setpublic Field39P setCurrency(String component2)
component2
- the Currency to setpublic Field39P 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 getAmount()
public Number getAmountAsNumber()
null
if cannot be convertedpublic Field39P setComponent3(String component3)
component3
- the component3 to setpublic Field39P setComponent3(Number component3)
component3
- the Number with the component3 content to setpublic Field39P setAmount(String component3)
component3
- the Amount to setpublic Field39P setAmount(Number component3)
component3
- Number with the Amount content to setsetComponent3(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 Field39P get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field39P get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field39P> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field39P> 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)