@Generated public class Field68B extends Field implements Serializable, CurrencyContainer, DateContainer, AmountContainer, MultiLineField
Calendar
Calendar
String
Character
String
Number
Currency
Number
Calendar
Currency
Number
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENTS_PATTERN |
static Integer |
CONSIDERATION
Component number for the Consideration subfield
|
static Integer |
CONSIDERATION_CURRENCY
Component number for the Consideration Currency subfield
|
static Integer |
CONTRACT_NUMBER
Component number for the Contract Number subfield
|
static String |
F_68B
same as NAME, intended to be clear when using static imports
|
static Integer |
INDICATOR
Component number for the Indicator subfield
|
static Integer |
MATURITY_DATE
Component number for the Maturity Date subfield
|
static String |
NAME
Constant with the field name 68B
|
static String |
PARSER_PATTERN |
static Integer |
PRICE_PER_UNIT
Component number for the Price Per Unit subfield
|
static Integer |
PRICE_PER_UNIT_CURRENCY
Component number for the Price Per Unit Currency subfield
|
static Integer |
QUANTITY_OF_THE_COMMODITY
Component number for the Quantity Of The Commodity subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static Integer |
TRADE_DATE
Component number for the Trade Date subfield
|
static Integer |
UNIT
Component number for the Unit subfield
|
static Integer |
VALUE_DATE_OF_THE_CONSIDERATION
Component number for the Value Date Of The Consideration subfield
|
components
Constructor and Description |
---|
Field68B()
Default constructor.
|
Field68B(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field68B(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 Field68B |
get(SwiftMessage msg)
Get the first instance of Field68B in the given message.
|
static Field68B |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field68B> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field68B in the given message
an empty list is returned if none found.
|
static List<Field68B> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field68B from the given block
an empty list is returned if none found.
|
String |
getComponent1()
Get the component1
|
String |
getComponent10()
Get the component10
|
Currency |
getComponent10AsCurrency()
Get the component10 as Currency
|
String |
getComponent11()
Get the component11
|
Number |
getComponent11AsNumber()
Get the component11 as Number
|
Calendar |
getComponent1AsCalendar()
Get the component1 as Calendar
|
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
|
String |
getComponent5()
Get the component5
|
String |
getComponent5AsString()
Deprecated.
|
String |
getComponent6()
Get the component6
|
Number |
getComponent6AsNumber()
Get the component6 as Number
|
String |
getComponent7()
Get the component7
|
Currency |
getComponent7AsCurrency()
Get the component7 as Currency
|
String |
getComponent8()
Get the component8
|
Number |
getComponent8AsNumber()
Get the component8 as Number
|
String |
getComponent9()
Get the component9
|
Calendar |
getComponent9AsCalendar()
Get the component9 as Calendar
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getConsideration()
Get the Consideration (component11).
|
Number |
getConsiderationAsNumber()
Get the Consideration (component11) as Number
|
String |
getConsiderationCurrency()
Get the Consideration Currency (component10).
|
Currency |
getConsiderationCurrencyAsCurrency()
Get the Consideration Currency (component10) as Currency
|
String |
getContractNumber()
Get the Contract Number (component3).
|
String |
getIndicator()
Get the Indicator (component4).
|
String |
getLine(int line)
Returns a specific line from the field's value.
|
String |
getLine(int line,
int offset)
Returns a specific line from the field's value.
|
List<String> |
getLines()
Returns the field value split into lines.
|
List<String> |
getLines(int offset)
Returns the field value starting at the offset component, split into lines.
|
List<String> |
getLinesBetween(int start,
int end)
Returns a specific subset of lines from the field's value, given a range.
|
List<String> |
getLinesBetween(int start,
int end,
int offset)
Returns a specific subset of lines from the field's value, starting at the offset component.
|
String |
getMaturityDate()
Get the Maturity Date (component2).
|
Calendar |
getMaturityDateAsCalendar()
Get the Maturity Date (component2) as Calendar
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getPricePerUnit()
Get the Price Per Unit (component8).
|
Number |
getPricePerUnitAsNumber()
Get the Price Per Unit (component8) as Number
|
String |
getPricePerUnitCurrency()
Get the Price Per Unit Currency (component7).
|
Currency |
getPricePerUnitCurrencyAsCurrency()
Get the Price Per Unit Currency (component7) as Currency
|
String |
getQuantityOfTheCommodity()
Get the Quantity Of The Commodity (component6).
|
Number |
getQuantityOfTheCommodityAsNumber()
Get the Quantity Of The Commodity (component6) as Number
|
String |
getTradeDate()
Get the Trade Date (component1).
|
Calendar |
getTradeDateAsCalendar()
Get the Trade Date (component1) as Calendar
|
String |
getUnit()
Get the Unit (component5).
|
String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
String |
getValueDateOfTheConsideration()
Get the Value Date Of The Consideration (component9).
|
Calendar |
getValueDateOfTheConsiderationAsCalendar()
Get the Value Date Of The Consideration (component9) as Calendar
|
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 Field68B |
newInstance(Field68B 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() |
Field68B |
setComponent1(Calendar component1)
Set the component1 from a Calendar object.
|
Field68B |
setComponent1(String component1)
Set the component1.
|
Field68B |
setComponent10(Currency component10)
Set the component10 from a Currency object.
|
Field68B |
setComponent10(String component10)
Set the component10.
|
Field68B |
setComponent11(Number component11)
Set the component11 from a Number object.
|
Field68B |
setComponent11(String component11)
Set the component11.
|
Field68B |
setComponent2(Calendar component2)
Set the component2 from a Calendar object.
|
Field68B |
setComponent2(String component2)
Set the component2.
|
Field68B |
setComponent3(String component3)
Set the component3.
|
Field68B |
setComponent4(String component4)
Set the component4.
|
Field68B |
setComponent5(String component5)
Set the component5.
|
Field68B |
setComponent6(Number component6)
Set the component6 from a Number object.
|
Field68B |
setComponent6(String component6)
Set the component6.
|
Field68B |
setComponent7(Currency component7)
Set the component7 from a Currency object.
|
Field68B |
setComponent7(String component7)
Set the component7.
|
Field68B |
setComponent8(Number component8)
Set the component8 from a Number object.
|
Field68B |
setComponent8(String component8)
Set the component8.
|
Field68B |
setComponent9(Calendar component9)
Set the component9 from a Calendar object.
|
Field68B |
setComponent9(String component9)
Set the component9.
|
Field68B |
setConsideration(Number component11)
Set the Consideration (component11) from a Number object.
|
Field68B |
setConsideration(String component11)
Set the Consideration (component11).
|
Field68B |
setConsiderationCurrency(Currency component10)
Set the Consideration Currency (component10) from a Currency object.
|
Field68B |
setConsiderationCurrency(String component10)
Set the Consideration Currency (component10).
|
Field68B |
setContractNumber(String component3)
Set the Contract Number (component3).
|
Field68B |
setIndicator(String component4)
Set the Indicator (component4).
|
Field68B |
setMaturityDate(Calendar component2)
Set the Maturity Date (component2) from a Calendar object.
|
Field68B |
setMaturityDate(String component2)
Set the Maturity Date (component2).
|
Field68B |
setPricePerUnit(Number component8)
Set the Price Per Unit (component8) from a Number object.
|
Field68B |
setPricePerUnit(String component8)
Set the Price Per Unit (component8).
|
Field68B |
setPricePerUnitCurrency(Currency component7)
Set the Price Per Unit Currency (component7) from a Currency object.
|
Field68B |
setPricePerUnitCurrency(String component7)
Set the Price Per Unit Currency (component7).
|
Field68B |
setQuantityOfTheCommodity(Number component6)
Set the Quantity Of The Commodity (component6) from a Number object.
|
Field68B |
setQuantityOfTheCommodity(String component6)
Set the Quantity Of The Commodity (component6).
|
Field68B |
setTradeDate(Calendar component1)
Set the Trade Date (component1) from a Calendar object.
|
Field68B |
setTradeDate(String component1)
Set the Trade Date (component1).
|
Field68B |
setUnit(String component5)
Set the Unit (component5).
|
Field68B |
setValueDateOfTheConsideration(Calendar component9)
Set the Value Date Of The Consideration (component9) from a Calendar object.
|
Field68B |
setValueDateOfTheConsideration(String component9)
Set the Value Date Of The Consideration (component9).
|
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_68B
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer TRADE_DATE
public static final Integer MATURITY_DATE
public static final Integer CONTRACT_NUMBER
public static final Integer INDICATOR
public static final Integer UNIT
public static final Integer QUANTITY_OF_THE_COMMODITY
public static final Integer PRICE_PER_UNIT_CURRENCY
public static final Integer PRICE_PER_UNIT
public static final Integer VALUE_DATE_OF_THE_CONSIDERATION
public static final Integer CONSIDERATION_CURRENCY
public static final Integer CONSIDERATION
public Field68B()
public Field68B(String value)
value
- complete field value including separators and CRLFpublic Field68B(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 Field68B newInstance(Field68B 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 Calendar getComponent1AsCalendar()
null
if cannot be convertedpublic String getTradeDate()
public Calendar getTradeDateAsCalendar()
null
if cannot be convertedpublic Field68B setComponent1(String component1)
component1
- the component1 to setpublic Field68B setComponent1(Calendar component1)
component1
- the Calendar with the component1 content to setpublic Field68B setTradeDate(String component1)
component1
- the Trade Date to setpublic Field68B setTradeDate(Calendar component1)
component1
- Calendar with the Trade Date content to setsetComponent1(java.util.Calendar)
public String getComponent2()
public Calendar getComponent2AsCalendar()
null
if cannot be convertedpublic String getMaturityDate()
public Calendar getMaturityDateAsCalendar()
null
if cannot be convertedpublic Field68B setComponent2(String component2)
component2
- the component2 to setpublic Field68B setComponent2(Calendar component2)
component2
- the Calendar with the component2 content to setpublic Field68B setMaturityDate(String component2)
component2
- the Maturity Date to setpublic Field68B setMaturityDate(Calendar component2)
component2
- Calendar with the Maturity Date content to setsetComponent2(java.util.Calendar)
public String getComponent3()
@Deprecated public String getComponent3AsString()
public String getContractNumber()
public Field68B setComponent3(String component3)
component3
- the component3 to setpublic Field68B setContractNumber(String component3)
component3
- the Contract Number to setpublic String getComponent4()
public String getIndicator()
public Field68B setComponent4(String component4)
component4
- the component4 to setpublic Field68B setIndicator(String component4)
component4
- the Indicator to setpublic String getComponent5()
@Deprecated public String getComponent5AsString()
public String getUnit()
public Field68B setComponent5(String component5)
component5
- the component5 to setpublic Field68B setUnit(String component5)
component5
- the Unit to setpublic String getComponent6()
public Number getComponent6AsNumber()
null
if cannot be convertedpublic String getQuantityOfTheCommodity()
public Number getQuantityOfTheCommodityAsNumber()
null
if cannot be convertedpublic Field68B setComponent6(String component6)
component6
- the component6 to setpublic Field68B setComponent6(Number component6)
component6
- the Number with the component6 content to setpublic Field68B setQuantityOfTheCommodity(String component6)
component6
- the Quantity Of The Commodity to setpublic Field68B setQuantityOfTheCommodity(Number component6)
component6
- Number with the Quantity Of The Commodity content to setsetComponent6(java.lang.Number)
public String getComponent7()
public Currency getComponent7AsCurrency()
null
if cannot be convertedpublic String getPricePerUnitCurrency()
public Currency getPricePerUnitCurrencyAsCurrency()
null
if cannot be convertedpublic Field68B setComponent7(String component7)
component7
- the component7 to setpublic Field68B setComponent7(Currency component7)
component7
- the Currency with the component7 content to setpublic Field68B setPricePerUnitCurrency(String component7)
component7
- the Price Per Unit Currency to setpublic Field68B setPricePerUnitCurrency(Currency component7)
component7
- Currency with the Price Per Unit Currency content to setsetComponent7(java.util.Currency)
public String getComponent8()
public Number getComponent8AsNumber()
null
if cannot be convertedpublic String getPricePerUnit()
public Number getPricePerUnitAsNumber()
null
if cannot be convertedpublic Field68B setComponent8(String component8)
component8
- the component8 to setpublic Field68B setComponent8(Number component8)
component8
- the Number with the component8 content to setpublic Field68B setPricePerUnit(String component8)
component8
- the Price Per Unit to setpublic Field68B setPricePerUnit(Number component8)
component8
- Number with the Price Per Unit content to setsetComponent8(java.lang.Number)
public String getComponent9()
public Calendar getComponent9AsCalendar()
null
if cannot be convertedpublic String getValueDateOfTheConsideration()
public Calendar getValueDateOfTheConsiderationAsCalendar()
null
if cannot be convertedpublic Field68B setComponent9(String component9)
component9
- the component9 to setpublic Field68B setComponent9(Calendar component9)
component9
- the Calendar with the component9 content to setpublic Field68B setValueDateOfTheConsideration(String component9)
component9
- the Value Date Of The Consideration to setpublic Field68B setValueDateOfTheConsideration(Calendar component9)
component9
- Calendar with the Value Date Of The Consideration content to setsetComponent9(java.util.Calendar)
public String getComponent10()
public Currency getComponent10AsCurrency()
null
if cannot be convertedpublic String getConsiderationCurrency()
public Currency getConsiderationCurrencyAsCurrency()
null
if cannot be convertedpublic Field68B setComponent10(String component10)
component10
- the component10 to setpublic Field68B setComponent10(Currency component10)
component10
- the Currency with the component10 content to setpublic Field68B setConsiderationCurrency(String component10)
component10
- the Consideration Currency to setpublic Field68B setConsiderationCurrency(Currency component10)
component10
- Currency with the Consideration Currency content to setsetComponent10(java.util.Currency)
public String getComponent11()
public Number getComponent11AsNumber()
null
if cannot be convertedpublic String getConsideration()
public Number getConsiderationAsNumber()
null
if cannot be convertedpublic Field68B setComponent11(String component11)
component11
- the component11 to setpublic Field68B setComponent11(Number component11)
component11
- the Number with the component11 content to setpublic Field68B setConsideration(String component11)
component11
- the Consideration to setpublic Field68B setConsideration(Number component11)
component11
- Number with the Consideration content to setsetComponent11(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 Field68B get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field68B get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field68B> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field68B> 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 getLine(int line)
getLine
in interface MultiLineField
line
- a reference to a specific line in the field, first line being 1MultiLineField.getLine(int)
public String getLine(int line, int offset)
getLine
in interface MultiLineField
line
- a reference to a specific line in the field, first line being 1offset
- an optional component number used as offset when counting linesMultiLineField.getLine(int, int)
public List<String> getLines()
getLines
in interface MultiLineField
MultiLineField.getLines()
public List<String> getLines(int offset)
getLines
in interface MultiLineField
offset
- an optional component number used as offset when counting linesMultiLineField.getLines(int)
public List<String> getLinesBetween(int start, int end)
getLinesBetween
in interface MultiLineField
start
- a reference to a specific line in the field, first line being 1end
- a reference to a specific line in the field, must be greater than startMultiLineField.getLinesBetween(int, int )
public List<String> getLinesBetween(int start, int end, int offset)
getLinesBetween
in interface MultiLineField
start
- a reference to a specific line in the field, first line being 1end
- a reference to a specific line in the field, must be greater than startoffset
- an optional component number used as offset when counting linesMultiLineField.getLinesBetween(int start, int end, int offset)
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)