Class Field37H
- java.lang.Object
-
- com.prowidesoftware.swift.model.field.Field
-
- com.prowidesoftware.swift.model.field.Field37H
-
- All Implemented Interfaces:
JsonSerializable
,AmountContainer
,PatternContainer
,java.io.Serializable
@Generated public class Field37H extends Field implements java.io.Serializable, AmountContainer
SWIFT MT Field 37H.Model and parser for field 37H of a SWIFT MT message.
Subfields (components) Data types
- Component 1: Indicator:
String
- Component 2: Sign:
String
- Component 3: Rate:
BigDecimal
Structure definition
- validation pattern:
<DC>[<N>]<AMOUNT>12
- parser pattern:
c[c]N
- components pattern:
SSN
This class complies with standard release SRU2023
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COMPONENTS_PATTERN
Deprecated.UsetypesPattern()
method instead.static java.lang.Integer
DC_MARK
Deprecated.use #INDICATOR insteadstatic java.lang.String
F_37H
Same as NAME, intended to be clear when using static imports.static java.lang.Integer
INDICATOR
Component number for the Indicator subfield.static java.lang.String
NAME
Constant with the field name 37H.static java.lang.String
PARSER_PATTERN
Deprecated.UseparserPattern()
method instead.static java.lang.Integer
RATE
Component number for the Rate subfield.static java.lang.Integer
SIGN
Component number for the Sign 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 Field37H()
Default constructor.Field37H(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.Field37H(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.static Tag
emptyTag()
Create a Tag with this field name and an empty string as value.static Field37H
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field37H object.static Field37H
get(SwiftMessage msg)
Gets the first instance of Field37H in the given message.static Field37H
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.static java.util.List<Field37H>
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field37H in the given message an empty list is returned if none found.static java.util.List<Field37H>
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field37H from the given block an empty list is returned if none found.java.lang.String
getComponent1()
Gets the component 1 (Indicator).java.lang.String
getComponent2()
Gets the component 2 (Sign).java.lang.String
getComponent3()
Gets the component 3 (Rate).java.math.BigDecimal
getComponent3AsBigDecimal()
Get the component 3 as BigDecimaljava.lang.Number
getComponent3AsNumber()
Deprecated.use #getComponent3AsBigDecimal() insteadjava.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
getDCMark()
Deprecated.use #getIndicator() insteadjava.lang.String
getIndicator()
Gets the Indicator (component 1).protected java.util.Map<java.lang.String,java.lang.Integer>
getLabelMap()
Returns a mapping between component labels and the internal component number.java.lang.String
getName()
Returns the field's name composed by the field number and the letter option (if any).java.lang.String
getRate()
Gets the Rate (component 3).java.math.BigDecimal
getRateAsBigDecimal()
Get the Rate (component 3) as BigDecimaljava.lang.Number
getRateAsNumber()
Deprecated.use #getRateAsBigDecimal() insteadjava.lang.String
getSign()
Gets the Sign (component 2).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.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 Field37H
newInstance(Field37H 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.Field37H
setComponent1(java.lang.String component1)
Set the component 1 (Indicator).Field37H
setComponent2(java.lang.String component2)
Set the component 2 (Sign).Field37H
setComponent3(java.lang.Number component3)
Alternative method setter for field's Rate (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)Field37H
setComponent3(java.lang.String component3)
Set the component 3 (Rate).Field37H
setComponent3(java.math.BigDecimal component3)
Set the component3 from a BigDecimal object.Field37H
setDCMark(java.lang.String component1)
Deprecated.use #setIndicator(String) insteadField37H
setIndicator(java.lang.String component1)
Set the Indicator (component 1).Field37H
setRate(java.lang.Number component3)
Alternative method setter for field's Rate (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)Field37H
setRate(java.lang.String component3)
Set the Rate (component 3).Field37H
setRate(java.math.BigDecimal component3)
Set the Rate (component 3) from a BigDecimal object.Field37H
setSign(java.lang.String component2)
Set the Sign (component 2).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 37H.- See Also:
- Constant Field Values
-
F_37H
public static final java.lang.String F_37H
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
-
INDICATOR
public static final java.lang.Integer INDICATOR
Component number for the Indicator subfield.
-
DC_MARK
@Deprecated @ProwideDeprecated(phase4=SRU2024) public static final java.lang.Integer DC_MARK
Deprecated.use #INDICATOR instead
-
SIGN
public static final java.lang.Integer SIGN
Component number for the Sign subfield.
-
RATE
public static final java.lang.Integer RATE
Component number for the Rate subfield.
-
-
Constructor Detail
-
Field37H
public Field37H()
Default constructor. Creates a new field setting all components to null.
-
Field37H
public Field37H(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
-
Field37H
public Field37H(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 Field37H newInstance(Field37H 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 (Indicator).- Returns:
- the component 1
-
getIndicator
public java.lang.String getIndicator()
Gets the Indicator (component 1).- Returns:
- the Indicator from component 1
-
getDCMark
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.String getDCMark()
Deprecated.use #getIndicator() insteadAlternative DEPRECATED method getter for field's Indicator- Since:
- 9.2.7
-
getComponent2
public java.lang.String getComponent2()
Gets the component 2 (Sign).- Returns:
- the component 2
-
getSign
public java.lang.String getSign()
Gets the Sign (component 2).- Returns:
- the Sign from component 2
-
getComponent3
public java.lang.String getComponent3()
Gets the component 3 (Rate).- Returns:
- the component 3
-
getComponent3AsBigDecimal
public java.math.BigDecimal getComponent3AsBigDecimal()
Get the component 3 as BigDecimal- Returns:
- the component 3 converted to BigDecimal or null if cannot be converted
- Since:
- 9.2.7
-
getComponent3AsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getComponent3AsNumber()
Deprecated.use #getComponent3AsBigDecimal() instead
-
getRate
public java.lang.String getRate()
Gets the Rate (component 3).- Returns:
- the Rate from component 3
-
getRateAsBigDecimal
public java.math.BigDecimal getRateAsBigDecimal()
Get the Rate (component 3) as BigDecimal- Returns:
- the Rate from component 3 converted to BigDecimal or null if cannot be converted
- Since:
- 9.2.7
-
getRateAsNumber
@Deprecated @ProwideDeprecated(phase4=SRU2024) public java.lang.Number getRateAsNumber()
Deprecated.use #getRateAsBigDecimal() instead
-
setComponent1
public Field37H setComponent1(java.lang.String component1)
Set the component 1 (Indicator).- Parameters:
component1
- the Indicator to set- Returns:
- the field object to enable build pattern
-
setIndicator
public Field37H setIndicator(java.lang.String component1)
Set the Indicator (component 1).- Parameters:
component1
- the Indicator to set- Returns:
- the field object to enable build pattern
-
setDCMark
@Deprecated @ProwideDeprecated(phase4=SRU2024) public Field37H setDCMark(java.lang.String component1)
Deprecated.use #setIndicator(String) instead
-
setComponent2
public Field37H setComponent2(java.lang.String component2)
Set the component 2 (Sign).- Parameters:
component2
- the Sign to set- Returns:
- the field object to enable build pattern
-
setSign
public Field37H setSign(java.lang.String component2)
Set the Sign (component 2).- Parameters:
component2
- the Sign to set- Returns:
- the field object to enable build pattern
-
setComponent3
public Field37H setComponent3(java.lang.String component3)
Set the component 3 (Rate).- Parameters:
component3
- the Rate to set- Returns:
- the field object to enable build pattern
-
setComponent3
public Field37H setComponent3(java.math.BigDecimal component3)
Set the component3 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:
component3
- the BigDecimal with the Rate content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
-
setComponent3
public Field37H setComponent3(java.lang.Number component3)
Alternative method setter for field's Rate (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)- Parameters:
component3
- the Number with the Rate content to set- Returns:
- the field object to enable build pattern
- See Also:
setRate(java.math.BigDecimal)
-
setRate
public Field37H setRate(java.lang.String component3)
Set the Rate (component 3).- Parameters:
component3
- the Rate to set- Returns:
- the field object to enable build pattern
-
setRate
public Field37H setRate(java.math.BigDecimal component3)
Set the Rate (component 3) from a BigDecimal object.- Parameters:
component3
- BigDecimal with the Rate content to set- Returns:
- the field object to enable build pattern
- Since:
- 9.2.7
- See Also:
setComponent3(java.math.BigDecimal)
-
setRate
public Field37H setRate(java.lang.Number component3)
Alternative method setter for field's Rate (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 Rate content to set- Returns:
- the field object to enable build pattern
- See Also:
setRate(java.math.BigDecimal)
-
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:
AmountResolver.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:
AmountResolver.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 Field37H 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 Field37H get(SwiftMessage msg)
Gets the first instance of Field37H 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<Field37H> getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field37H 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<Field37H> getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field37H 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 Field37H fromJson(java.lang.String json)
This method deserializes the JSON data into a Field37H 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)
-
-