@Generated public class Field92B extends Field implements java.io.Serializable, CurrencyContainer, AmountContainer, GenericField
StringCurrencyCurrencyNumber:4!c//<CUR>/<CUR>/<AMOUNT>15:S//S/S/NSCCNThis class complies with standard release SRU2017
NOTE: this source code has been generated from template
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield
|
static java.lang.String |
F_92B
same as NAME, intended to be clear when using static imports
|
static java.lang.Integer |
FIRST_CURRENCY_CODE
Component number for the First Currency Code subfield
|
static java.lang.String |
NAME
Constant with the field name 92B
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
QUALIFIER
Component number for the Qualifier subfield
|
static java.lang.Integer |
RATE
Component number for the Rate subfield
|
static java.lang.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(java.lang.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 |
|---|---|
java.math.BigDecimal |
amount()
Get the first amount in this field.
|
java.util.List<java.math.BigDecimal> |
amounts() |
java.lang.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. |
java.util.List<java.util.Currency> |
currencies()
Utility method that creates a Currency for every string returned by
CurrencyContainer.currencyStrings() |
java.util.Currency |
currency()
Analog to
CurrencyContainer.currencyString() |
java.lang.String |
currencyString()
Get the single currency contained in this field.
|
java.util.List<java.lang.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 java.util.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 java.util.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.
|
java.lang.String |
getComponent1()
Get the component1
|
java.lang.String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
java.lang.String |
getComponent2()
Get the component2
|
java.util.Currency |
getComponent2AsCurrency()
Get the component2 as Currency
|
java.lang.String |
getComponent3()
Get the component3
|
java.util.Currency |
getComponent3AsCurrency()
Get the component3 as Currency
|
java.lang.String |
getComponent4()
Get the component4
|
java.lang.Number |
getComponent4AsNumber()
Get the component4 as Number
|
protected java.util.List<java.lang.String> |
getComponentLabels()
Returns english label for components.
|
java.lang.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. |
java.lang.String |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
java.lang.String |
getFirstCurrencyCode()
Get the First Currency Code (component2).
|
java.util.Currency |
getFirstCurrencyCodeAsCurrency()
Get the First Currency Code (component2) as Currency
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getQualifier()
Get the Qualifier (component1).
|
java.lang.String |
getRate()
Get the Rate (component4).
|
java.lang.Number |
getRateAsNumber()
Get the Rate (component4) as Number
|
java.lang.String |
getSecondCurrencyCode()
Get the Second Currency Code (component3).
|
java.util.Currency |
getSecondCurrencyCodeAsCurrency()
Get the Second Currency Code (component3) as Currency
|
java.lang.String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
java.lang.String |
getValueDisplay(int component,
java.util.Locale locale)
Returns a localized suitable for showing to humans string of a field component.
|
void |
initializeCurrencies(java.util.Currency cur) |
void |
initializeCurrencies(java.lang.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(java.lang.String value)
Parses the parameter value into the internal components structure.
|
java.lang.String |
parserPattern() |
Field92B |
setComponent1(java.lang.String component1)
Set the component1.
|
Field92B |
setComponent2(java.util.Currency component2)
Set the component2 from a Currency object.
|
Field92B |
setComponent2(java.lang.String component2)
Set the component2.
|
Field92B |
setComponent3(java.util.Currency component3)
Set the component3 from a Currency object.
|
Field92B |
setComponent3(java.lang.String component3)
Set the component3.
|
Field92B |
setComponent4(java.lang.Number component4)
Set the component4 from a Number object.
|
Field92B |
setComponent4(java.lang.String component4)
Set the component4.
|
Field92B |
setFirstCurrencyCode(java.util.Currency component2)
Set the First Currency Code (component2) from a Currency object.
|
Field92B |
setFirstCurrencyCode(java.lang.String component2)
Set the First Currency Code (component2).
|
Field92B |
setQualifier(java.lang.String component1)
Set the Qualifier (component1).
|
Field92B |
setRate(java.lang.Number component4)
Set the Rate (component4) from a Number object.
|
Field92B |
setRate(java.lang.String component4)
Set the Rate (component4).
|
Field92B |
setSecondCurrencyCode(java.util.Currency component3)
Set the Second Currency Code (component3) from a Currency object.
|
Field92B |
setSecondCurrencyCode(java.lang.String component3)
Set the Second Currency Code (component3).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
java.lang.String |
validatorPattern()
Returns the field's validators pattern
|
append, 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, is, isAnyOf, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toString, validNamepublic static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_92B
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer QUALIFIER
public static final java.lang.Integer FIRST_CURRENCY_CODE
public static final java.lang.Integer SECOND_CURRENCY_CODE
public static final java.lang.Integer RATE
public static final java.lang.Integer CONDITIONAL_QUALIFIER
public Field92B()
public Field92B(java.lang.String value)
value - complete field value including separators and CRLFpublic Field92B(Tag tag)
parse(String)java.lang.IllegalArgumentException - if the parameter tag is null or its tagname does not match the field namepublic void parse(java.lang.String value)
public static Field92B newInstance(Field92B source)
source - a field instance to copypublic java.lang.String getValue()
public static Tag tag(java.lang.String value)
new Tag(NAME, value)NAMEpublic static Tag emptyTag()
new Tag(NAME, "")NAMEpublic java.lang.String getComponent1()
@Deprecated @ProwideDeprecated(phase2=_2018) public java.lang.String getComponent1AsString()
Field.getComponent(int) insteadpublic java.lang.String getQualifier()
public Field92B setComponent1(java.lang.String component1)
component1 - the component1 to setpublic Field92B setQualifier(java.lang.String component1)
component1 - the Qualifier to setpublic java.lang.String getComponent2()
public java.util.Currency getComponent2AsCurrency()
null if cannot be convertedpublic java.lang.String getFirstCurrencyCode()
public java.util.Currency getFirstCurrencyCodeAsCurrency()
null if cannot be convertedpublic Field92B setComponent2(java.lang.String component2)
component2 - the component2 to setpublic Field92B setComponent2(java.util.Currency component2)
component2 - the Currency with the component2 content to setpublic Field92B setFirstCurrencyCode(java.lang.String component2)
component2 - the First Currency Code to setpublic Field92B setFirstCurrencyCode(java.util.Currency component2)
component2 - Currency with the First Currency Code content to setsetComponent2(java.util.Currency)public java.lang.String getComponent3()
public java.util.Currency getComponent3AsCurrency()
null if cannot be convertedpublic java.lang.String getSecondCurrencyCode()
public java.util.Currency getSecondCurrencyCodeAsCurrency()
null if cannot be convertedpublic Field92B setComponent3(java.lang.String component3)
component3 - the component3 to setpublic Field92B setComponent3(java.util.Currency component3)
component3 - the Currency with the component3 content to setpublic Field92B setSecondCurrencyCode(java.lang.String component3)
component3 - the Second Currency Code to setpublic Field92B setSecondCurrencyCode(java.util.Currency component3)
component3 - Currency with the Second Currency Code content to setsetComponent3(java.util.Currency)public java.lang.String getComponent4()
public java.lang.Number getComponent4AsNumber()
null if cannot be convertedpublic java.lang.String getRate()
public java.lang.Number getRateAsNumber()
null if cannot be convertedpublic Field92B setComponent4(java.lang.String component4)
component4 - the component4 to setpublic Field92B setComponent4(java.lang.Number component4)
component4 - the Number with the component4 content to setpublic Field92B setRate(java.lang.String component4)
component4 - the Rate to setpublic Field92B setRate(java.lang.Number component4)
component4 - Number with the Rate content to setsetComponent4(java.lang.Number)public java.util.List<java.lang.String> currencyStrings()
CurrencyContainercurrencyStrings in interface CurrencyContainerpublic java.util.List<java.util.Currency> currencies()
CurrencyContainerCurrencyContainer.currencyStrings()currencies in interface CurrencyContainerpublic java.util.Currency currency()
CurrencyContainerCurrencyContainer.currencyString()currency in interface CurrencyContainerCurrencyContainer.currencyStrings(),
CurrencyContainer.currencyString()public java.lang.String currencyString()
CurrencyContainercurrencyString in interface CurrencyContainerpublic void initializeCurrencies(java.lang.String cur)
CurrencyContainerinitializeCurrencies in interface CurrencyContainerpublic void initializeCurrencies(java.util.Currency cur)
initializeCurrencies in interface CurrencyContainerCurrencyContainer.initializeCurrencies(String)public java.util.List<java.math.BigDecimal> amounts()
AmountResolver.amounts(Field)public java.math.BigDecimal amount()
AmountContaineramount in interface AmountContainerAmountResolver.amount(Field)public boolean isOptional(int component)
isOptional in class Fieldcomponent - component number, first component of a field is referenced as 1public boolean isGeneric()
public java.lang.String getDSS()
getDSS in interface GenericFieldgetDSS in class Fieldnull if the DSS is not set or not available for this field.public boolean isDSSPresent()
isDSSPresent in interface GenericFieldisDSSPresent in class FieldgetDSS()public java.lang.String getConditionalQualifier()
getConditionalQualifier in interface GenericFieldgetConditionalQualifier in class Fieldnull if not set or not applicable for this kind of field.public java.lang.String parserPattern()
parserPattern in interface PatternContainerpublic java.lang.String getName()
public final java.lang.String componentsPattern()
componentsPattern in interface PatternContainercomponentsPattern in class Fieldpublic final java.lang.String validatorPattern()
validatorPattern in class Fieldpublic 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 java.util.List<Field92B> getAll(SwiftMessage msg)
msg - may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)public static java.util.List<Field92B> getAll(SwiftTagListBlock block)
block - may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize in class Fieldpublic java.lang.String getValueDisplay(int component,
java.util.Locale locale)
getValueDisplay in class Fieldcomponent - number of the component to displaylocale - optional locale to format date and amounts, if null, the default locale is usedjava.lang.IllegalArgumentException - if component number is invalid for the fieldprotected java.util.List<java.lang.String> getComponentLabels()
getComponentLabels in class FieldField.getComponentLabel(int)