Class Field68A
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.Field68A
-
- All Implemented Interfaces:
JsonSerializable
,AmountContainer
,CurrencyContainer
,MonetaryAmountContainer
,PatternContainer
,java.io.Serializable
@Generated public class Field68A extends Field implements java.io.Serializable, MonetaryAmountContainer
SWIFT MT Field 68A.Model and parser for field 68A of a SWIFT MT message.
Subfields (components) Data types
- Component 1: Number:
Long
- Component 2: Currency:
Currency
- Component 3: Denomination:
Long
- Component 4: Mode:
Long
- Component 5: Amount:
BigDecimal
- Component 6: ProductCode:
String
Structure definition
- validation pattern:
6n<CUR>6n/2n[/<AMOUNT>15][//10x]
- parser pattern:
NSN/N[/N][//S]
- components pattern:
NCNNNS
This class complies with standard release SRU2023
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.Integer
AMOUNT
Component number for the Amount subfield.static java.lang.String
COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.static java.lang.Integer
CURRENCY
Component number for the Currency subfield.static java.lang.Integer
DENOMINATION
Component number for the Denomination subfield.static java.lang.String
F_68A
Same as NAME, intended to be clear when using static imports.static java.lang.Integer
MODE
Component number for the Mode subfield.static java.lang.String
NAME
Constant with the field name 68A.static java.lang.Integer
NUMBER
Component number for the Number subfield.static java.lang.String
PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.static java.lang.Integer
PRODUCT_CODE
Component number for the Product Code subfield.static int
SRU
Constant identifying the SRU to which this class belongs to.static java.lang.String
TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.-
Fields inherited from class com.prowidesoftware.swift.model.field.Field
components, labelMap
-
-
Constructor Summary
Constructors Constructor Description Field68A()
Default constructor.Field68A(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field68A(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.math.BigDecimal
amount()
Returns the first amounts as BigDecimaljava.util.List<java.math.BigDecimal>
amounts()
Returns the list of all NON-NULL amounts as BigDecimaljava.lang.String
componentsPattern()
Deprecated.UsetypesPattern()
instead.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 byCurrencyContainer.currencyStrings()
java.util.Currency
currency()
Analog toCurrencyContainer.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 fieldstatic Tag
emptyTag()
Create a Tag with this field name and an empty string as value.static Field68A
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field68A object.static Field68A
get(SwiftMessage msg)
Gets the first instance of Field68A in the given message.static Field68A
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.static java.util.List<Field68A>
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field68A in the given message an empty list is returned if none found.static java.util.List<Field68A>
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field68A from the given block an empty list is returned if none found.java.lang.String
getAmount()
Gets the Amount (component 5).java.math.BigDecimal
getAmountAsBigDecimal()
Get the Amount (component 5) as BigDecimaljava.lang.Number
getAmountAsNumber()
Deprecated.use #getAmountAsBigDecimal() insteadjava.lang.String
getComponent1()
Gets the component 1 (Number).java.lang.Long
getComponent1AsLong()
Get the component 1 as Longjava.lang.Number
getComponent1AsNumber()
Deprecated.use #getComponent1AsLong() insteadjava.lang.String
getComponent2()
Gets the component 2 (Currency).java.util.Currency
getComponent2AsCurrency()
Get the component 2 as Currencyjava.lang.String
getComponent3()
Gets the component 3 (Denomination).java.lang.Long
getComponent3AsLong()
Get the component 3 as Longjava.lang.Number
getComponent3AsNumber()
Deprecated.use #getComponent3AsLong() insteadjava.lang.String
getComponent4()
Gets the component 4 (Mode).java.lang.Long
getComponent4AsLong()
Get the component 4 as Longjava.lang.Number
getComponent4AsNumber()
Deprecated.use #getComponent4AsLong() insteadjava.lang.String
getComponent5()
Gets the component 5 (Amount).java.math.BigDecimal
getComponent5AsBigDecimal()
Get the component 5 as BigDecimaljava.lang.Number
getComponent5AsNumber()
Deprecated.use #getComponent5AsBigDecimal() insteadjava.lang.String
getComponent6()
Gets the component 6 (Product Code).java.util.List<java.lang.String>
getComponentLabels()
Returns english label for components.protected java.util.Map<java.lang.Integer,java.lang.String>
getComponentMap()
Returns a mapping between component numbers and their label in camel case format.java.lang.String
getCurrency()
Gets the Currency (component 2).java.util.Currency
getCurrencyAsCurrency()
Get the Currency (component 2) as Currencyjava.lang.String
getDenomination()
Gets the Denomination (component 3).java.lang.Long
getDenominationAsLong()
Get the Denomination (component 3) as Longjava.lang.Number
getDenominationAsNumber()
Deprecated.use #getDenominationAsLong() insteadprotected java.util.Map<java.lang.String,java.lang.Integer>
getLabelMap()
Returns a mapping between component labels and the internal component number.java.lang.String
getMode()
Gets the Mode (component 4).java.lang.Long
getModeAsLong()
Get the Mode (component 4) as Longjava.lang.Number
getModeAsNumber()
Deprecated.use #getModeAsLong() insteadjava.lang.String
getName()
Returns the field's name composed by the field number and the letter option (if any).java.lang.String
getNumber()
Gets the Number (component 1).java.lang.Long
getNumberAsLong()
Get the Number (component 1) as Longjava.lang.Number
getNumberAsNumber()
Deprecated.use #getNumberAsLong() insteadjava.lang.String
getProductCode()
Gets the Product Code (component 6).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.lang.String cur)
Set the currency of this field.void
initializeCurrencies(java.util.Currency cur)
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.void
parse(java.lang.String value)
Parses the parameter value into the internal components structure.java.lang.String
parserPattern()
Returns the field parser pattern.Field68A
setAmount(java.lang.Number component5)
Alternative method setter for field's Amount (component 5) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)Field68A
setAmount(java.lang.String component5)
Set the Amount (component 5).Field68A
setAmount(java.math.BigDecimal component5)
Set the Amount (component 5) from a BigDecimal object.Field68A
setComponent1(java.lang.Long component1)
Set the component1 from a Long object.Field68A
setComponent1(java.lang.Number component1)
Alternative method setter for field's Number (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)Field68A
setComponent1(java.lang.String component1)
Set the component 1 (Number).Field68A
setComponent2(java.lang.String component2)
Set the component 2 (Currency).Field68A
setComponent2(java.util.Currency component2)
Set the component2 from a Currency object.Field68A
setComponent3(java.lang.Long component3)
Set the component3 from a Long object.Field68A
setComponent3(java.lang.Number component3)
Alternative method setter for field's Denomination (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)Field68A
setComponent3(java.lang.String component3)
Set the component 3 (Denomination).Field68A
setComponent4(java.lang.Long component4)
Set the component4 from a Long object.Field68A
setComponent4(java.lang.Number component4)
Alternative method setter for field's Mode (component 4) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)Field68A
setComponent4(java.lang.String component4)
Set the component 4 (Mode).Field68A
setComponent5(java.lang.Number component5)
Alternative method setter for field's Amount (component 5) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)Field68A
setComponent5(java.lang.String component5)
Set the component 5 (Amount).Field68A
setComponent5(java.math.BigDecimal component5)
Set the component5 from a BigDecimal object.Field68A
setComponent6(java.lang.String component6)
Set the component 6 (Product Code).Field68A
setCurrency(java.lang.String component2)
Set the Currency (component 2).Field68A
setCurrency(java.util.Currency component2)
Set the Currency (component 2) from a Currency object.Field68A
setDenomination(java.lang.Long component3)
Set the Denomination (component 3) from a Long object.Field68A
setDenomination(java.lang.Number component3)
Alternative method setter for field's Denomination (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)Field68A
setDenomination(java.lang.String component3)
Set the Denomination (component 3).Field68A
setMode(java.lang.Long component4)
Set the Mode (component 4) from a Long object.Field68A
setMode(java.lang.Number component4)
Alternative method setter for field's Mode (component 4) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)Field68A
setMode(java.lang.String component4)
Set the Mode (component 4).Field68A
setNumber(java.lang.Long component1)
Set the Number (component 1) from a Long object.Field68A
setNumber(java.lang.Number component1)
Alternative method setter for field's Number (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)Field68A
setNumber(java.lang.String component1)
Set the Number (component 1).Field68A
setProductCode(java.lang.String component6)
Set the Product Code (component 6).static Tag
tag(java.lang.String value)
Create a Tag with this field name and the given value.java.lang.String
typesPattern()
Returns the field component types pattern.java.lang.String
validatorPattern()
Returns the field validator pattern-
Methods inherited from class com.prowidesoftware.swift.model.field.Field
append, appendInLines, appendInLines, asTag, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponent, getComponentAs, getComponentAs, getComponentAsNumber, getComponentAsNumber, getComponentLabel, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponent, setComponents, toJson, toString, validName
-
-
-
-
Field Detail
-
SRU
public static final int SRU
Constant identifying the SRU to which this class belongs to.- See Also:
- Constant Field Values
-
NAME
public static final java.lang.String NAME
Constant with the field name 68A.- See Also:
- Constant Field Values
-
F_68A
public static final java.lang.String F_68A
Same as NAME, intended to be clear when using static imports.- See Also:
- Constant Field Values
-
PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.- See Also:
- Constant Field Values
-
COMPONENTS_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
TYPES_PATTERN
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.String TYPES_PATTERN
Deprecated.UsetypesPattern()
method instead.- See Also:
- Constant Field Values
-
NUMBER
public static final java.lang.Integer NUMBER
Component number for the Number subfield.
-
CURRENCY
public static final java.lang.Integer CURRENCY
Component number for the Currency subfield.
-
DENOMINATION
public static final java.lang.Integer DENOMINATION
Component number for the Denomination subfield.
-
MODE
public static final java.lang.Integer MODE
Component number for the Mode subfield.
-
AMOUNT
public static final java.lang.Integer AMOUNT
Component number for the Amount subfield.
-
PRODUCT_CODE
public static final java.lang.Integer PRODUCT_CODE
Component number for the Product Code subfield.
-
-
Constructor Detail
-
Field68A
public Field68A()
Default constructor. Creates a new field setting all components to null.
-
Field68A
public Field68A(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.- Parameters:
value
- complete field value including separators and CRLF
-
Field68A
public Field68A(Tag tag)
Creates a new field and initializes its components with content from the parameter tag. The value is parsed withparse(String)
- Throws:
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field name- Since:
- 7.8
-
-
Method Detail
-
newInstance
public static Field68A newInstance(Field68A source)
Copy constructor. Initializes the components list with a deep copy of the source components list.- Parameters:
source
- a field instance to copy- Since:
- 7.7
-
tag
public static Tag tag(java.lang.String value)
Create a Tag with this field name and the given value. Shorthand fornew Tag(NAME, value)
- Since:
- 7.5
- See Also:
NAME
-
emptyTag
public static Tag emptyTag()
Create a Tag with this field name and an empty string as value. Shorthand fornew Tag(NAME, "")
- Since:
- 7.5
- See Also:
NAME
-
parse
public void parse(java.lang.String value)
Parses the parameter value into the internal components structure.Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
-
getValue
public java.lang.String getValue()
Serializes the fields' components into the single string value (SWIFT format)
-
getValueDisplay
public java.lang.String getValueDisplay(int component, java.util.Locale locale)
Returns a localized suitable for showing to humans string of a field component.- Specified by:
getValueDisplay
in classField
- Parameters:
component
- number of the component to displaylocale
- optional locale to format date and amounts, if null, the default locale is used- Returns:
- formatted component value or null if component number is invalid or not present
- Throws:
java.lang.IllegalArgumentException
- if component number is invalid for the field- Since:
- 7.8
-
componentsPattern
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String componentsPattern()
Deprecated.UsetypesPattern()
instead.- Specified by:
componentsPattern
in classField
-
typesPattern
public java.lang.String typesPattern()
Returns the field component types pattern. This method returns a letter representing the type for each component in the Field. It supersedes the Components Pattern because it distinguishes between N (Number) and I (BigDecimal).- Specified by:
typesPattern
in interfacePatternContainer
- Specified by:
typesPattern
in classField
- Since:
- 9.2.7
-
parserPattern
public java.lang.String parserPattern()
Returns the field parser pattern.- Specified by:
parserPattern
in interfacePatternContainer
-
validatorPattern
public java.lang.String validatorPattern()
Returns the field validator pattern- Specified by:
validatorPattern
in classField
-
isOptional
public 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.- Specified by:
isOptional
in classField
- Parameters:
component
- component number, first component of a field is referenced as 1- Returns:
- true if the component is optional for this field, false otherwise
-
isGeneric
public boolean isGeneric()
Returns true if the field is a GENERIC FIELD as specified by the standard.
-
componentsSize
public 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.- Specified by:
componentsSize
in classField
- Since:
- 7.7
-
getComponentLabels
public java.util.List<java.lang.String> getComponentLabels()
Returns english label for components.
The index in the list is in sync with specific field component structure.- Specified by:
getComponentLabels
in classField
- Since:
- 7.8.4
- See Also:
Field.getComponentLabel(int)
-
getComponentMap
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
Returns a mapping between component numbers and their label in camel case format.- Specified by:
getComponentMap
in classField
- Since:
- 7.10.3
-
getLabelMap
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Description copied from class:Field
Returns a mapping between component labels and the internal component number. Component labels are in lowercase and without spaces and separators. If a for a given component there is more than one label option, both are mapped to the same component number.- Specified by:
getLabelMap
in classField
- Since:
- 9.3.12
- See Also:
Field.getLabelMap()
-
getComponent1
public java.lang.String getComponent1()
Gets the component 1 (Number).- Returns:
- the component 1
-
getComponent1AsLong
public java.lang.Long getComponent1AsLong()
Get the component 1 as Long- Returns:
- the component 1 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getComponent1AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent1AsNumber()
Deprecated.use #getComponent1AsLong() instead
-
getNumber
public java.lang.String getNumber()
Gets the Number (component 1).- Returns:
- the Number from component 1
-
getNumberAsLong
public java.lang.Long getNumberAsLong()
Get the Number (component 1) as Long- Returns:
- the Number from component 1 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getNumberAsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getNumberAsNumber()
Deprecated.use #getNumberAsLong() instead
-
getComponent2
public java.lang.String getComponent2()
Gets the component 2 (Currency).- Returns:
- the component 2
-
getComponent2AsCurrency
public java.util.Currency getComponent2AsCurrency()
Get the component 2 as Currency- Returns:
- the component 2 converted to Currency or null if cannot be converted
-
getCurrency
public java.lang.String getCurrency()
Gets the Currency (component 2).- Returns:
- the Currency from component 2
-
getCurrencyAsCurrency
public java.util.Currency getCurrencyAsCurrency()
Get the Currency (component 2) as Currency- Returns:
- the Currency from component 2 converted to Currency or null if cannot be converted
-
getComponent3
public java.lang.String getComponent3()
Gets the component 3 (Denomination).- Returns:
- the component 3
-
getComponent3AsLong
public java.lang.Long getComponent3AsLong()
Get the component 3 as Long- Returns:
- the component 3 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getComponent3AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent3AsNumber()
Deprecated.use #getComponent3AsLong() instead
-
getDenomination
public java.lang.String getDenomination()
Gets the Denomination (component 3).- Returns:
- the Denomination from component 3
-
getDenominationAsLong
public java.lang.Long getDenominationAsLong()
Get the Denomination (component 3) as Long- Returns:
- the Denomination from component 3 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getDenominationAsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getDenominationAsNumber()
Deprecated.use #getDenominationAsLong() instead
-
getComponent4
public java.lang.String getComponent4()
Gets the component 4 (Mode).- Returns:
- the component 4
-
getComponent4AsLong
public java.lang.Long getComponent4AsLong()
Get the component 4 as Long- Returns:
- the component 4 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getComponent4AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent4AsNumber()
Deprecated.use #getComponent4AsLong() instead
-
getMode
public java.lang.String getMode()
Gets the Mode (component 4).- Returns:
- the Mode from component 4
-
getModeAsLong
public java.lang.Long getModeAsLong()
Get the Mode (component 4) as Long- Returns:
- the Mode from component 4 converted to Long or null if cannot be converted
- Since:
- 9.2.7
-
getModeAsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getModeAsNumber()
Deprecated.use #getModeAsLong() instead
-
getComponent5
public java.lang.String getComponent5()
Gets the component 5 (Amount).- Returns:
- the component 5
-
getComponent5AsBigDecimal
public java.math.BigDecimal getComponent5AsBigDecimal()
Get the component 5 as BigDecimal- Returns:
- the component 5 converted to BigDecimal or null if cannot be converted
- Since:
- 9.2.7
-
getComponent5AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent5AsNumber()
Deprecated.use #getComponent5AsBigDecimal() instead
-
getAmount
public java.lang.String getAmount()
Gets the Amount (component 5).- Returns:
- the Amount from component 5
-
getAmountAsBigDecimal
public java.math.BigDecimal getAmountAsBigDecimal()
Get the Amount (component 5) as BigDecimal- Returns:
- the Amount from component 5 converted to BigDecimal or null if cannot be converted
- Since:
- 9.2.7
-
getAmountAsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getAmountAsNumber()
Deprecated.use #getAmountAsBigDecimal() instead
-
getComponent6
public java.lang.String getComponent6()
Gets the component 6 (Product Code).- Returns:
- the component 6
-
getProductCode
public java.lang.String getProductCode()
Gets the Product Code (component 6).- Returns:
- the Product Code from component 6
-
setComponent1
public Field68A setComponent1(java.lang.String component1)
Set the component 1 (Number).- Parameters:
component1
- the Number to set- Returns:
- the field object to enable build pattern
-
setComponent1
public Field68A setComponent1(java.lang.Long component1)
Set the component1 from a Long object.
If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent1(String) method.- Parameters:
component1
- the Long with the Number content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent1(String)
-
setComponent1
public Field68A setComponent1(java.lang.Number component1)
Alternative method setter for field's Number (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)- Parameters:
component1
- the Number with the Number content to set- Returns:
- the field object to enable build pattern
- See Also:
setNumber(java.lang.Long)
-
setNumber
public Field68A setNumber(java.lang.String component1)
Set the Number (component 1).- Parameters:
component1
- the Number to set- Returns:
- the field object to enable build pattern
-
setNumber
public Field68A setNumber(java.lang.Long component1)
Set the Number (component 1) from a Long object.- Parameters:
component1
- Long with the Number content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent1(java.lang.Long)
-
setNumber
public Field68A setNumber(java.lang.Number component1)
Alternative method setter for field's Number (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)- Parameters:
component1
- the Number with the Number content to set- Returns:
- the field object to enable build pattern
- See Also:
setNumber(java.lang.Long)
-
setComponent2
public Field68A setComponent2(java.lang.String component2)
Set the component 2 (Currency).- Parameters:
component2
- the Currency to set- Returns:
- the field object to enable build pattern
-
setComponent2
public Field68A setComponent2(java.util.Currency component2)
Set the component2 from a Currency object.- Parameters:
component2
- the Currency with the Currency content to set- Returns:
- the field object to enable build pattern
-
setCurrency
public Field68A setCurrency(java.lang.String component2)
Set the Currency (component 2).- Parameters:
component2
- the Currency to set- Returns:
- the field object to enable build pattern
-
setCurrency
public Field68A setCurrency(java.util.Currency component2)
Set the Currency (component 2) from a Currency object.- Parameters:
component2
- Currency with the Currency content to set- Returns:
- the field object to enable build pattern
- See Also:
setComponent2(java.util.Currency)
-
setComponent3
public Field68A setComponent3(java.lang.String component3)
Set the component 3 (Denomination).- Parameters:
component3
- the Denomination to set- Returns:
- the field object to enable build pattern
-
setComponent3
public Field68A setComponent3(java.lang.Long component3)
Set the component3 from a Long object.
If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent3(String) method.- Parameters:
component3
- the Long with the Denomination content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent3(String)
-
setComponent3
public Field68A setComponent3(java.lang.Number component3)
Alternative method setter for field's Denomination (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)- Parameters:
component3
- the Number with the Denomination content to set- Returns:
- the field object to enable build pattern
- See Also:
setDenomination(java.lang.Long)
-
setDenomination
public Field68A setDenomination(java.lang.String component3)
Set the Denomination (component 3).- Parameters:
component3
- the Denomination to set- Returns:
- the field object to enable build pattern
-
setDenomination
public Field68A setDenomination(java.lang.Long component3)
Set the Denomination (component 3) from a Long object.- Parameters:
component3
- Long with the Denomination content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent3(java.lang.Long)
-
setDenomination
public Field68A setDenomination(java.lang.Number component3)
Alternative method setter for field's Denomination (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)- Parameters:
component3
- the Number with the Denomination content to set- Returns:
- the field object to enable build pattern
- See Also:
setDenomination(java.lang.Long)
-
setComponent4
public Field68A setComponent4(java.lang.String component4)
Set the component 4 (Mode).- Parameters:
component4
- the Mode to set- Returns:
- the field object to enable build pattern
-
setComponent4
public Field68A setComponent4(java.lang.Long component4)
Set the component4 from a Long object.
If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent4(String) method.- Parameters:
component4
- the Long with the Mode content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent4(String)
-
setComponent4
public Field68A setComponent4(java.lang.Number component4)
Alternative method setter for field's Mode (component 4) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)- Parameters:
component4
- the Number with the Mode content to set- Returns:
- the field object to enable build pattern
- See Also:
setMode(java.lang.Long)
-
setMode
public Field68A setMode(java.lang.String component4)
Set the Mode (component 4).- Parameters:
component4
- the Mode to set- Returns:
- the field object to enable build pattern
-
setMode
public Field68A setMode(java.lang.Long component4)
Set the Mode (component 4) from a Long object.- Parameters:
component4
- Long with the Mode content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent4(java.lang.Long)
-
setMode
public Field68A setMode(java.lang.Number component4)
Alternative method setter for field's Mode (component 4) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)- Parameters:
component4
- the Number with the Mode content to set- Returns:
- the field object to enable build pattern
- See Also:
setMode(java.lang.Long)
-
setComponent5
public Field68A setComponent5(java.lang.String component5)
Set the component 5 (Amount).- Parameters:
component5
- the Amount to set- Returns:
- the field object to enable build pattern
-
setComponent5
public Field68A setComponent5(java.math.BigDecimal component5)
Set the component5 from a BigDecimal object.
Parses the BigDecimal into a SWIFT amount with truncated zero decimals and mandatory decimal separator.- Example: 1234.00 -> 1234,
- Example: 1234 -> 1234,
- Example: 1234.56 -> 1234,56
- Parameters:
component5
- the BigDecimal with the Amount content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
-
setComponent5
public Field68A setComponent5(java.lang.Number component5)
Alternative method setter for field's Amount (component 5) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)- Parameters:
component5
- the Number with the Amount content to set- Returns:
- the field object to enable build pattern
- See Also:
setAmount(java.math.BigDecimal)
-
setAmount
public Field68A setAmount(java.lang.String component5)
Set the Amount (component 5).- Parameters:
component5
- the Amount to set- Returns:
- the field object to enable build pattern
-
setAmount
public Field68A setAmount(java.math.BigDecimal component5)
Set the Amount (component 5) from a BigDecimal object.- Parameters:
component5
- BigDecimal with the Amount content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent5(java.math.BigDecimal)
-
setAmount
public Field68A setAmount(java.lang.Number component5)
Alternative method setter for field's Amount (component 5) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)- Parameters:
component5
- the Number with the Amount content to set- Returns:
- the field object to enable build pattern
- See Also:
setAmount(java.math.BigDecimal)
-
setComponent6
public Field68A setComponent6(java.lang.String component6)
Set the component 6 (Product Code).- Parameters:
component6
- the Product Code to set- Returns:
- the field object to enable build pattern
-
setProductCode
public Field68A setProductCode(java.lang.String component6)
Set the Product Code (component 6).- Parameters:
component6
- the Product Code to set- Returns:
- the field object to enable build pattern
-
currencyStrings
public java.util.List<java.lang.String> currencyStrings()
Description copied from interface:CurrencyContainer
Get a list of strings of currencies present in this field- Specified by:
currencyStrings
in interfaceCurrencyContainer
- Returns:
- found currency codes or empty list
-
currencies
public java.util.List<java.util.Currency> currencies()
Description copied from interface:CurrencyContainer
Utility method that creates a Currency for every string returned byCurrencyContainer.currencyStrings()
- Specified by:
currencies
in interfaceCurrencyContainer
- Returns:
- found currencies or empty list
-
currency
public java.util.Currency currency()
Description copied from interface:CurrencyContainer
Analog toCurrencyContainer.currencyString()
- Specified by:
currency
in interfaceCurrencyContainer
- See Also:
CurrencyContainer.currencyStrings()
,CurrencyContainer.currencyString()
-
currencyString
public java.lang.String currencyString()
Description copied from interface:CurrencyContainer
Get the single currency contained in this field.- Specified by:
currencyString
in interfaceCurrencyContainer
- Returns:
- null if no currency is contained - which should never happen, or throws an exception if more than one currency is present in this field.
-
initializeCurrencies
public void initializeCurrencies(java.lang.String cur)
Description copied from interface:CurrencyContainer
Set the currency of this field. If this field contains more than one currency then all currency components will be set. Individual setComponentNN should be used to set only one component of the field.- Specified by:
initializeCurrencies
in interfaceCurrencyContainer
-
initializeCurrencies
public void initializeCurrencies(java.util.Currency cur)
- Specified by:
initializeCurrencies
in interfaceCurrencyContainer
- See Also:
CurrencyContainer.initializeCurrencies(String)
-
amounts
public java.util.List<java.math.BigDecimal> amounts()
Returns the list of all NON-NULL amounts as BigDecimal- Returns:
- the list of NON-NULL amounts as BigDecimal values
- See Also:
MonetaryAmountResolver.amounts(Field)
-
amount
public java.math.BigDecimal amount()
Returns the first amounts as BigDecimal- Specified by:
amount
in interfaceAmountContainer
- Returns:
- the first amount as BigDecimal value. Can be null
- See Also:
MonetaryAmountResolver.amount(Field)
-
getName
public java.lang.String getName()
Returns the field's name composed by the field number and the letter option (if any).
-
get
public static Field68A get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.- Parameters:
block
- may be null or empty- Returns:
- null if not found o block is null or empty
-
get
public static Field68A get(SwiftMessage msg)
Gets the first instance of Field68A in the given message.- Parameters:
msg
- may be empty or null- Returns:
- null if not found or msg is empty or null
- See Also:
get(SwiftTagListBlock)
-
getAll
public static java.util.List<Field68A> getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field68A in the given message an empty list is returned if none found.- Parameters:
msg
- may be empty or null in which case an empty list is returned- See Also:
getAll(SwiftTagListBlock)
-
getAll
public static java.util.List<Field68A> getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field68A from the given block an empty list is returned if none found.- Parameters:
block
- may be empty or null in which case an empty list is returned
-
fromJson
public static Field68A fromJson(java.lang.String json)
This method deserializes the JSON data into a Field68A object.- Parameters:
json
- JSON structure including tuples with label and value for all field components- Returns:
- a new field instance with the JSON data parsed into field components or an empty field id the JSON is invalid
- Since:
- 7.10.3
- See Also:
Field.fromJson(String)
-
-