@Generated public class Field33N extends Field implements Serializable, CurrencyContainer, DateContainer, AmountContainer
String
Calendar
Currency
Number
Modifier and Type | Field and Description |
---|---|
static Integer |
AMOUNT
Component number for the Amount subfield
|
static String |
COMPONENTS_PATTERN |
static Integer |
CURRENCY
Component number for the Currency subfield
|
static Integer |
DATE
Component number for the Date subfield
|
static String |
F_33N
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 33N
|
static String |
PARSER_PATTERN |
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 |
---|
Field33N()
Default constructor.
|
Field33N(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field33N(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<Currency> |
currencies()
Utility method that creates a Currency for every string returned by
CurrencyContainer.currencyStrings() |
Currency |
currency()
Analog to
CurrencyContainer.currencyString() |
String |
currencyString()
Get the single currency contained in this field.
|
List<String> |
currencyStrings()
Get a list of strings of currencies present in this field
|
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 Field33N |
get(SwiftMessage msg)
Get the first instance of Field33N in the given message.
|
static Field33N |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field33N> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field33N in the given message
an empty list is returned if none found.
|
static List<Field33N> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field33N from the given block
an empty list is returned if none found.
|
String |
getAmount()
Get the Amount (component4).
|
Number |
getAmountAsNumber()
Get the Amount (component4) as Number
|
String |
getComponent1()
Get the component1
|
String |
getComponent1AsString()
Deprecated.
|
String |
getComponent2()
Get the component2
|
Calendar |
getComponent2AsCalendar()
Get the component2 as Calendar
|
String |
getComponent3()
Get the component3
|
Currency |
getComponent3AsCurrency()
Get the component3 as Currency
|
String |
getComponent4()
Get the component4
|
Number |
getComponent4AsNumber()
Get the component4 as Number
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getCurrency()
Get the Currency (component3).
|
Currency |
getCurrencyAsCurrency()
Get the Currency (component3) as Currency
|
String |
getDate()
Get the Date (component2).
|
Calendar |
getDateAsCalendar()
Get the Date (component2) as Calendar
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getSign()
Get the Sign (component1).
|
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.
|
void |
initializeCurrencies(Currency cur) |
void |
initializeCurrencies(String cur)
set the currency of this field.
|
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 Field33N |
newInstance(Field33N 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() |
Field33N |
setAmount(Number component4)
Set the Amount (component4) from a Number object.
|
Field33N |
setAmount(String component4)
Set the Amount (component4).
|
Field33N |
setComponent1(String component1)
Set the component1.
|
Field33N |
setComponent2(Calendar component2)
Set the component2 from a Calendar object.
|
Field33N |
setComponent2(String component2)
Set the component2.
|
Field33N |
setComponent3(Currency component3)
Set the component3 from a Currency object.
|
Field33N |
setComponent3(String component3)
Set the component3.
|
Field33N |
setComponent4(Number component4)
Set the component4 from a Number object.
|
Field33N |
setComponent4(String component4)
Set the component4.
|
Field33N |
setCurrency(Currency component3)
Set the Currency (component3) from a Currency object.
|
Field33N |
setCurrency(String component3)
Set the Currency (component3).
|
Field33N |
setDate(Calendar component2)
Set the Date (component2) from a Calendar object.
|
Field33N |
setDate(String component2)
Set the Date (component2).
|
Field33N |
setSign(String component1)
Set the Sign (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, setComponent, setComponents, toString, validName
public static final int SRU
public static final String NAME
public static final String F_33N
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer SIGN
public static final Integer DATE
public static final Integer CURRENCY
public static final Integer AMOUNT
public Field33N()
public Field33N(String value)
value
- complete field value including separators and CRLFpublic Field33N(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 Field33N newInstance(Field33N 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 getSign()
public Field33N setComponent1(String component1)
component1
- the component1 to setpublic Field33N setSign(String component1)
component1
- the Sign to setpublic String getComponent2()
public Calendar getComponent2AsCalendar()
null
if cannot be convertedpublic String getDate()
public Calendar getDateAsCalendar()
null
if cannot be convertedpublic Field33N setComponent2(String component2)
component2
- the component2 to setpublic Field33N setComponent2(Calendar component2)
component2
- the Calendar with the component2 content to setpublic Field33N setDate(String component2)
component2
- the Date to setpublic Field33N setDate(Calendar component2)
component2
- Calendar with the Date content to setsetComponent2(java.util.Calendar)
public String getComponent3()
public Currency getComponent3AsCurrency()
null
if cannot be convertedpublic String getCurrency()
public Currency getCurrencyAsCurrency()
null
if cannot be convertedpublic Field33N setComponent3(String component3)
component3
- the component3 to setpublic Field33N setComponent3(Currency component3)
component3
- the Currency with the component3 content to setpublic Field33N setCurrency(String component3)
component3
- the Currency to setpublic Field33N setCurrency(Currency component3)
component3
- Currency with the Currency content to setsetComponent3(java.util.Currency)
public String getComponent4()
public Number getComponent4AsNumber()
null
if cannot be convertedpublic String getAmount()
public Number getAmountAsNumber()
null
if cannot be convertedpublic Field33N setComponent4(String component4)
component4
- the component4 to setpublic Field33N setComponent4(Number component4)
component4
- the Number with the component4 content to setpublic Field33N setAmount(String component4)
component4
- the Amount to setpublic Field33N setAmount(Number component4)
component4
- Number with the Amount content to setsetComponent4(java.lang.Number)
public List<String> currencyStrings()
CurrencyContainer
currencyStrings
in interface CurrencyContainer
public List<Currency> currencies()
CurrencyContainer
CurrencyContainer.currencyStrings()
currencies
in interface CurrencyContainer
public Currency currency()
CurrencyContainer
CurrencyContainer.currencyString()
currency
in interface CurrencyContainer
CurrencyContainer.currencyStrings()
,
CurrencyContainer.currencyString()
public String currencyString()
CurrencyContainer
currencyString
in interface CurrencyContainer
public void initializeCurrencies(String cur)
CurrencyContainer
initializeCurrencies
in interface CurrencyContainer
public void initializeCurrencies(Currency cur)
initializeCurrencies
in interface CurrencyContainer
CurrencyContainer.initializeCurrencies(String)
public List<Calendar> dates()
DateContainer
dates
in interface DateContainer
public List<BigDecimal> amounts()
public BigDecimal amount()
AmountContainer
amount
in interface AmountContainer
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 Field33N get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field33N get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field33N> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field33N> 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)