@Generated public class Field92B extends Field implements Serializable, CurrencyContainer, AmountContainer, GenericField
String
Currency
Currency
Number
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENTS_PATTERN |
static Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield
|
static String |
F_92B
same as NAME, intended to be clear when using static imports
|
static Integer |
FIRST_CURRENCY_CODE
Component number for the First Currency Code subfield
|
static String |
NAME
Constant with the field name 92B
|
static String |
PARSER_PATTERN |
static Integer |
QUALIFIER
Component number for the Qualifier subfield
|
static Integer |
RATE
Component number for the Rate subfield
|
static Integer |
SECOND_CURRENCY_CODE
Component number for the Second Currency Code subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field92B()
Default constructor.
|
Field92B(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field92B(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 Field92B |
get(SwiftMessage msg)
Get the first instance of Field92B in the given message.
|
static Field92B |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field92B> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field92B in the given message
an empty list is returned if none found.
|
static List<Field92B> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field92B from the given block
an empty list is returned if none found.
|
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
|
Currency |
getComponent3AsCurrency()
Get the component3 as Currency
|
String |
getComponent4()
Get the component4
|
Number |
getComponent4AsNumber()
Get the component4 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 |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
String |
getFirstCurrencyCode()
Get the First Currency Code (component2).
|
Currency |
getFirstCurrencyCodeAsCurrency()
Get the First Currency Code (component2) as Currency
|
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 |
getRate()
Get the Rate (component4).
|
Number |
getRateAsNumber()
Get the Rate (component4) as Number
|
String |
getSecondCurrencyCode()
Get the Second Currency Code (component3).
|
Currency |
getSecondCurrencyCodeAsCurrency()
Get the Second Currency Code (component3) as Currency
|
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 |
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 Field92B |
newInstance(Field92B 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() |
Field92B |
setComponent1(String component1)
Set the component1.
|
Field92B |
setComponent2(Currency component2)
Set the component2 from a Currency object.
|
Field92B |
setComponent2(String component2)
Set the component2.
|
Field92B |
setComponent3(Currency component3)
Set the component3 from a Currency object.
|
Field92B |
setComponent3(String component3)
Set the component3.
|
Field92B |
setComponent4(Number component4)
Set the component4 from a Number object.
|
Field92B |
setComponent4(String component4)
Set the component4.
|
Field92B |
setFirstCurrencyCode(Currency component2)
Set the First Currency Code (component2) from a Currency object.
|
Field92B |
setFirstCurrencyCode(String component2)
Set the First Currency Code (component2).
|
Field92B |
setQualifier(String component1)
Set the Qualifier (component1).
|
Field92B |
setRate(Number component4)
Set the Rate (component4) from a Number object.
|
Field92B |
setRate(String component4)
Set the Rate (component4).
|
Field92B |
setSecondCurrencyCode(Currency component3)
Set the Second Currency Code (component3) from a Currency object.
|
Field92B |
setSecondCurrencyCode(String component3)
Set the Second Currency Code (component3).
|
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, notNull, setComponent, setComponents, toString, validName
public static final int SRU
public static final String NAME
public static final String F_92B
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer QUALIFIER
public static final Integer FIRST_CURRENCY_CODE
public static final Integer SECOND_CURRENCY_CODE
public static final Integer RATE
public static final Integer CONDITIONAL_QUALIFIER
public Field92B()
public Field92B(String value)
value
- complete field value including separators and CRLFpublic Field92B(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 Field92B newInstance(Field92B 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 Field92B setComponent1(String component1)
component1
- the component1 to setpublic Field92B setQualifier(String component1)
component1
- the Qualifier to setpublic String getComponent2()
public Currency getComponent2AsCurrency()
null
if cannot be convertedpublic String getFirstCurrencyCode()
public Currency getFirstCurrencyCodeAsCurrency()
null
if cannot be convertedpublic Field92B setComponent2(String component2)
component2
- the component2 to setpublic Field92B setComponent2(Currency component2)
component2
- the Currency with the component2 content to setpublic Field92B setFirstCurrencyCode(String component2)
component2
- the First Currency Code to setpublic Field92B setFirstCurrencyCode(Currency component2)
component2
- Currency with the First Currency Code content to setsetComponent2(java.util.Currency)
public String getComponent3()
public Currency getComponent3AsCurrency()
null
if cannot be convertedpublic String getSecondCurrencyCode()
public Currency getSecondCurrencyCodeAsCurrency()
null
if cannot be convertedpublic Field92B setComponent3(String component3)
component3
- the component3 to setpublic Field92B setComponent3(Currency component3)
component3
- the Currency with the component3 content to setpublic Field92B setSecondCurrencyCode(String component3)
component3
- the Second Currency Code to setpublic Field92B setSecondCurrencyCode(Currency component3)
component3
- Currency with the Second Currency Code content to setsetComponent3(java.util.Currency)
public String getComponent4()
public Number getComponent4AsNumber()
null
if cannot be convertedpublic String getRate()
public Number getRateAsNumber()
null
if cannot be convertedpublic Field92B setComponent4(String component4)
component4
- the component4 to setpublic Field92B setComponent4(Number component4)
component4
- the Number with the component4 content to setpublic Field92B setRate(String component4)
component4
- the Rate to setpublic Field92B setRate(Number component4)
component4
- Number with the Rate content to setsetComponent4(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 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 Field92B get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field92B get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field92B> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field92B> 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)