@Generated public class Field37B extends Field implements Serializable, DateContainer, AmountContainer
Number
Calendar
String
Number
String
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENTS_PATTERN |
static Integer |
DATE
Component number for the Date subfield
|
static Integer |
DM_MARK
Component number for the D/M Mark subfield
|
static String |
F_37B
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 37B
|
static String |
PARSER_PATTERN |
static Integer |
RATE
Component number for the Rate subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field37B()
Default constructor.
|
Field37B(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field37B(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<Calendar> |
dates()
Get a calendar for every date found
|
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value
Shorthand for
new Tag(NAME, "") |
static Field37B |
get(SwiftMessage msg)
Get the first instance of Field37B in the given message.
|
static Field37B |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field37B> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field37B in the given message
an empty list is returned if none found.
|
static List<Field37B> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field37B from the given block
an empty list is returned if none found.
|
String |
getComponent1()
Get the component1
|
Number |
getComponent1AsNumber()
Get the component1 as Number
|
String |
getComponent2()
Get the component2
|
Calendar |
getComponent2AsCalendar()
Get the component2 as Calendar
|
String |
getComponent3()
Get the component3
|
String |
getComponent3AsString()
Deprecated.
|
String |
getComponent4()
Get the component4
|
Number |
getComponent4AsNumber()
Get the component4 as Number
|
String |
getComponent5()
Get the component5
|
String |
getComponent5AsString()
Deprecated.
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getDate()
Get the Date (component2).
|
Calendar |
getDateAsCalendar()
Get the Date (component2) as Calendar
|
String |
getDMMark()
Get the D/M Mark (component3).
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getRate()
Get the Rate (component1).
|
Number |
getRateAsNumber()
Get the Rate (component1) as Number
|
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 Field37B |
newInstance(Field37B 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() |
Field37B |
setComponent1(Number component1)
Set the component1 from a Number object.
|
Field37B |
setComponent1(String component1)
Set the component1.
|
Field37B |
setComponent2(Calendar component2)
Set the component2 from a Calendar object.
|
Field37B |
setComponent2(String component2)
Set the component2.
|
Field37B |
setComponent3(String component3)
Set the component3.
|
Field37B |
setComponent4(Number component4)
Set the component4 from a Number object.
|
Field37B |
setComponent4(String component4)
Set the component4.
|
Field37B |
setComponent5(String component5)
Set the component5.
|
Field37B |
setDate(Calendar component2)
Set the Date (component2) from a Calendar object.
|
Field37B |
setDate(String component2)
Set the Date (component2).
|
Field37B |
setDMMark(String component3)
Set the D/M Mark (component3).
|
Field37B |
setRate(Number component1)
Set the Rate (component1) from a Number object.
|
Field37B |
setRate(String component1)
Set the Rate (component1).
|
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_37B
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer RATE
public static final Integer DATE
public static final Integer DM_MARK
public Field37B()
public Field37B(String value)
value
- complete field value including separators and CRLFpublic Field37B(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 Field37B newInstance(Field37B 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()
public Number getComponent1AsNumber()
null
if cannot be convertedpublic String getRate()
public Number getRateAsNumber()
null
if cannot be convertedpublic Field37B setComponent1(String component1)
component1
- the component1 to setpublic Field37B setComponent1(Number component1)
component1
- the Number with the component1 content to setpublic Field37B setRate(String component1)
component1
- the Rate to setpublic Field37B setRate(Number component1)
component1
- Number with the Rate content to setsetComponent1(java.lang.Number)
public String getComponent2()
public Calendar getComponent2AsCalendar()
null
if cannot be convertedpublic String getDate()
public Calendar getDateAsCalendar()
null
if cannot be convertedpublic Field37B setComponent2(String component2)
component2
- the component2 to setpublic Field37B setComponent2(Calendar component2)
component2
- the Calendar with the component2 content to setpublic Field37B setDate(String component2)
component2
- the Date to setpublic Field37B setDate(Calendar component2)
component2
- Calendar with the Date content to setsetComponent2(java.util.Calendar)
public String getComponent3()
@Deprecated public String getComponent3AsString()
public String getDMMark()
public Field37B setComponent3(String component3)
component3
- the component3 to setpublic Field37B setDMMark(String component3)
component3
- the D/M Mark to setpublic String getComponent4()
public Number getComponent4AsNumber()
null
if cannot be convertedpublic Field37B setComponent4(String component4)
component4
- the component4 to setpublic Field37B setComponent4(Number component4)
component4
- the Number with the component4 content to setpublic String getComponent5()
@Deprecated public String getComponent5AsString()
public Field37B setComponent5(String component5)
component5
- the component5 to setpublic List<Calendar> dates()
DateContainer
dates
in interface DateContainer
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 Field37B get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field37B get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field37B> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field37B> 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)