@Generated public class Field37H extends Field implements Serializable, AmountContainer
String
String
Number
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENTS_PATTERN |
static Integer |
DC_MARK
Component number for the D/C Mark subfield
|
static String |
F_37H
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 37H
|
static String |
PARSER_PATTERN |
static Integer |
RATE
Component number for the Rate subfield
|
static Integer |
SIGN
Component number for the Sign subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field37H()
Default constructor.
|
Field37H(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field37H(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. |
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value
Shorthand for
new Tag(NAME, "") |
static Field37H |
get(SwiftMessage msg)
Get the first instance of Field37H in the given message.
|
static Field37H |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field37H> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field37H in the given message
an empty list is returned if none found.
|
static List<Field37H> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field37H 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
|
String |
getComponent2AsString()
Deprecated.
|
String |
getComponent3()
Get the component3
|
Number |
getComponent3AsNumber()
Get the component3 as Number
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getDCMark()
Get the D/C Mark (component1).
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getRate()
Get the Rate (component3).
|
Number |
getRateAsNumber()
Get the Rate (component3) as Number
|
String |
getSign()
Get the Sign (component2).
|
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.
|
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.
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() |
Field37H |
setComponent1(String component1)
Set the component1.
|
Field37H |
setComponent2(String component2)
Set the component2.
|
Field37H |
setComponent3(Number component3)
Set the component3 from a Number object.
|
Field37H |
setComponent3(String component3)
Set the component3.
|
Field37H |
setDCMark(String component1)
Set the D/C Mark (component1).
|
Field37H |
setRate(Number component3)
Set the Rate (component3) from a Number object.
|
Field37H |
setRate(String component3)
Set the Rate (component3).
|
Field37H |
setSign(String component2)
Set the Sign (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_37H
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer DC_MARK
public static final Integer SIGN
public static final Integer RATE
public Field37H()
public Field37H(String value)
value
- complete field value including separators and CRLFpublic Field37H(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 Field37H newInstance(Field37H 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 getDCMark()
public Field37H setComponent1(String component1)
component1
- the component1 to setpublic Field37H setDCMark(String component1)
component1
- the D/C Mark to setpublic String getComponent2()
@Deprecated public String getComponent2AsString()
public String getSign()
public Field37H setComponent2(String component2)
component2
- the component2 to setpublic Field37H setSign(String component2)
component2
- the Sign to setpublic String getComponent3()
public Number getComponent3AsNumber()
null
if cannot be convertedpublic String getRate()
public Number getRateAsNumber()
null
if cannot be convertedpublic Field37H setComponent3(String component3)
component3
- the component3 to setpublic Field37H setComponent3(Number component3)
component3
- the Number with the component3 content to setpublic Field37H setRate(String component3)
component3
- the Rate to setpublic Field37H setRate(Number component3)
component3
- Number with the Rate content to setsetComponent3(java.lang.Number)
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 Field37H get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field37H get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field37H> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field37H> 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)