@Generated public class Field11R extends Field implements java.io.Serializable, DateContainer, MultiLineField
Model and parser for field 11R of a SWIFT MT message.
Subfields (components) Data types
Long
Calendar
Long
Long
Structure definition
<MT>$<DATE2>[$4!n6!n]
S$<DATE2>[$4!S6!S]
MENN
This class complies with standard release SRU2021
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
|
static java.lang.Integer |
DATE
Component number for the Date subfield
|
static java.lang.String |
F_11R
same as NAME, intended to be clear when using static imports
|
static java.lang.Integer |
ISN
Component number for the ISN subfield
|
static java.lang.Integer |
MT
Deprecated.
|
static java.lang.Integer |
MT_NUMBER
Component number for the MT Number subfield
|
static java.lang.String |
NAME
Constant with the field name 11R
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
SESSION_NUMBER
Component number for the Session Number subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
static java.lang.String |
TYPES_PATTERN
Types pattern
Contains a description of the type for every component, use instead of COMPONENTS_PATTERN.
|
components
Constructor and Description |
---|
Field11R()
Default constructor.
|
Field11R(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field11R(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
componentsPattern()
Deprecated.
|
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. |
java.util.Calendar |
date()
Returns the first component that can be converted to a Calendar
|
java.util.List<java.util.Calendar> |
dates()
Returns all components that can be converted to a Calendar
|
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value
Shorthand for
new Tag(NAME, "") |
static Field11R |
fromJson(java.lang.String json)
This method deserializes the JSON data into a Field11R object.
|
static Field11R |
get(SwiftMessage msg)
Gets the first instance of Field11R in the given message.
|
static Field11R |
get(SwiftTagListBlock block)
Gets the first occurrence form the tag list or null if not found.
|
static java.util.List<Field11R> |
getAll(SwiftMessage msg)
Gets a list of all occurrences of the field Field11R in the given message
an empty list is returned if none found.
|
static java.util.List<Field11R> |
getAll(SwiftTagListBlock block)
Gets a list of all occurrences of the field Field11R from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Gets the component 1 (MT Number).
|
java.lang.String |
getComponent2()
Gets the component 2 (Date).
|
java.util.Calendar |
getComponent2AsCalendar()
Get the component 2 as Calendar
|
java.lang.String |
getComponent3()
Gets the component 3 (Session Number).
|
java.lang.Long |
getComponent3AsLong()
Get the component 3 as Long
|
java.lang.Number |
getComponent3AsNumber()
Deprecated.
|
java.lang.String |
getComponent4()
Gets the component 4 (ISN).
|
java.lang.Long |
getComponent4AsLong()
Get the component 4 as Long
|
java.lang.Number |
getComponent4AsNumber()
Deprecated.
|
protected java.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 |
getDate()
Gets the Date (component 2).
|
java.util.Calendar |
getDateAsCalendar()
Get the Date (component 2) as Calendar
|
java.lang.String |
getISN()
Gets the ISN (component 4).
|
java.lang.Long |
getISNAsLong()
Get the ISN (component 4) as Long
|
java.lang.Number |
getISNAsNumber()
Deprecated.
|
java.lang.String |
getLine(int line)
Returns a specific line from the field's value.
|
java.lang.String |
getLine(int line,
int offset)
Returns a specific line from the field's value.
|
java.util.List<java.lang.String> |
getLines()
Returns the field value split into lines.
|
java.util.List<java.lang.String> |
getLines(int offset)
Returns the field value starting at the offset component, split into lines.
|
java.util.List<java.lang.String> |
getLinesBetween(int start,
int end)
Returns a specific subset of lines from the field's value, given a range.
|
java.util.List<java.lang.String> |
getLinesBetween(int start,
int end,
int offset)
Returns a specific subset of lines from the field's value, starting at the offset component.
|
java.lang.String |
getMT()
Deprecated.
|
java.lang.String |
getMTNumber()
Gets the MT Number (component 1).
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getSessionNumber()
Gets the Session Number (component 3).
|
java.lang.Long |
getSessionNumberAsLong()
Get the Session Number (component 3) as Long
|
java.lang.Number |
getSessionNumberAsNumber()
Deprecated.
|
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 Field11R |
newInstance(Field11R source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
void |
parse(java.lang.String value)
Parses the parameter value into the internal components structure.
|
java.lang.String |
parserPattern()
Returns the field parser pattern
|
Field11R |
setComponent1(java.lang.String component1)
Set the component 1 (MT Number).
|
Field11R |
setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.
|
Field11R |
setComponent2(java.lang.String component2)
Set the component 2 (Date).
|
Field11R |
setComponent3(java.lang.Long component3)
Set the component3 from a Long object.
|
Field11R |
setComponent3(java.lang.Number component3)
Alternative method setter for field's Session Number (component 3) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field11R |
setComponent3(java.lang.String component3)
Set the component 3 (Session Number).
|
Field11R |
setComponent4(java.lang.Long component4)
Set the component4 from a Long object.
|
Field11R |
setComponent4(java.lang.Number component4)
Alternative method setter for field's ISN (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field11R |
setComponent4(java.lang.String component4)
Set the component 4 (ISN).
|
Field11R |
setDate(java.util.Calendar component2)
Set the Date (component 2) from a Calendar object.
|
Field11R |
setDate(java.lang.String component2)
Set the Date (component 2).
|
Field11R |
setISN(java.lang.Long component4)
Set the ISN (component 4) from a Long object.
|
Field11R |
setISN(java.lang.Number component4)
Alternative method setter for field's ISN (component 4) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field11R |
setISN(java.lang.String component4)
Set the ISN (component 4).
|
Field11R |
setMT(java.lang.String component1)
Deprecated.
|
Field11R |
setMTNumber(java.lang.String component1)
Set the MT Number (component 1).
|
Field11R |
setSessionNumber(java.lang.Long component3)
Set the Session Number (component 3) from a Long object.
|
Field11R |
setSessionNumber(java.lang.Number component3)
Alternative method setter for field's Session Number (component 3) as as Number
This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
|
Field11R |
setSessionNumber(java.lang.String component3)
Set the Session Number (component 3).
|
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
This method returns a letter representing the type for each component in the Field.
|
java.lang.String |
validatorPattern()
Returns the field validator pattern
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toJson, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_11R
public static final java.lang.String PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String COMPONENTS_PATTERN
TYPES_PATTERN
,
Constant Field Valuespublic static final java.lang.String TYPES_PATTERN
public static final java.lang.Integer MT_NUMBER
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.Integer MT
MT_NUMBER
public static final java.lang.Integer DATE
public static final java.lang.Integer SESSION_NUMBER
public static final java.lang.Integer ISN
public Field11R()
public Field11R(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field11R(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic static Field11R newInstance(Field11R source)
source
- a field instance to copypublic static Tag tag(java.lang.String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public void parse(java.lang.String value)
Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
public java.lang.String getValue()
public java.lang.String getValueDisplay(int component, java.util.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 usedjava.lang.IllegalArgumentException
- if component number is invalid for the field@Deprecated @ProwideDeprecated(phase2=SRU2022) public final java.lang.String componentsPattern()
typesPattern()
instead.componentsPattern
in class Field
typesPattern()
public final java.lang.String typesPattern()
typesPattern
in interface PatternContainer
typesPattern
in class Field
TYPES_PATTERN
public final java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public final java.lang.String validatorPattern()
validatorPattern
in class 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 int componentsSize()
componentsSize
in class Field
protected java.util.List<java.lang.String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
getComponentMap
in class Field
public java.lang.String getComponent1()
public java.lang.String getMTNumber()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.String getMT()
getMTNumber()
public java.lang.String getComponent2()
public java.util.Calendar getComponent2AsCalendar()
public java.lang.String getDate()
public java.util.Calendar getDateAsCalendar()
public java.lang.String getComponent3()
public java.lang.Long getComponent3AsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getComponent3AsNumber()
getComponent3AsLong()
to get the proper value.getComponent3AsLong()
public java.lang.String getSessionNumber()
public java.lang.Long getSessionNumberAsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getSessionNumberAsNumber()
getComponent3AsLong()
to get the proper value.getSessionNumberAsLong()
public java.lang.String getComponent4()
public java.lang.Long getComponent4AsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getComponent4AsNumber()
getComponent4AsLong()
to get the proper value.getComponent4AsLong()
public java.lang.String getISN()
public java.lang.Long getISNAsLong()
@Deprecated @ProwideDeprecated(phase2=SRU2022) public java.lang.Number getISNAsNumber()
getComponent4AsLong()
to get the proper value.getISNAsLong()
public Field11R setComponent1(java.lang.String component1)
component1
- the MT Number to setpublic Field11R setMTNumber(java.lang.String component1)
component1
- the MT Number to set@Deprecated @ProwideDeprecated(phase2=SRU2022) public Field11R setMT(java.lang.String component1)
component1
- the MT Number to setsetMTNumber(String)
public Field11R setComponent2(java.lang.String component2)
component2
- the Date to setpublic Field11R setComponent2(java.util.Calendar component2)
component2
- the Calendar with the Date content to setpublic Field11R setDate(java.lang.String component2)
component2
- the Date to setpublic Field11R setDate(java.util.Calendar component2)
component2
- Calendar with the Date content to setsetComponent2(java.util.Calendar)
public Field11R setComponent3(java.lang.String component3)
component3
- the Session Number to setpublic Field11R setComponent3(java.lang.Long component3)
component3
- the Long with the Session Number content to setsetComponent3(String)
public Field11R setComponent3(java.lang.Number component3)
component3
- the Number with the Session Number content to setsetSessionNumber(java.lang.Long)
public Field11R setSessionNumber(java.lang.String component3)
component3
- the Session Number to setpublic Field11R setSessionNumber(java.lang.Long component3)
component3
- Long with the Session Number content to setsetComponent3(java.lang.Long)
public Field11R setSessionNumber(java.lang.Number component3)
component3
- the Number with the Session Number content to setsetSessionNumber(java.lang.Long)
public Field11R setComponent4(java.lang.String component4)
component4
- the ISN to setpublic Field11R setComponent4(java.lang.Long component4)
component4
- the Long with the ISN content to setsetComponent4(String)
public Field11R setComponent4(java.lang.Number component4)
component4
- the Number with the ISN content to setsetISN(java.lang.Long)
public Field11R setISN(java.lang.String component4)
component4
- the ISN to setpublic Field11R setISN(java.lang.Long component4)
component4
- Long with the ISN content to setsetComponent4(java.lang.Long)
public Field11R setISN(java.lang.Number component4)
component4
- the Number with the ISN content to setsetISN(java.lang.Long)
public java.util.List<java.util.Calendar> dates()
dates
in interface DateContainer
public java.util.Calendar date()
public java.lang.String getName()
public static Field11R get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field11R get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field11R> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field11R> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic java.lang.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 java.lang.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 java.util.List<java.lang.String> getLines()
getLines
in interface MultiLineField
MultiLineField.getLines()
public java.util.List<java.lang.String> getLines(int offset)
getLines
in interface MultiLineField
offset
- an optional component number used as offset when counting linesMultiLineField.getLines(int)
public java.util.List<java.lang.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 java.util.List<java.lang.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 static Field11R fromJson(java.lang.String json)
json
- JSON structure including tuples with label and value for all field componentsField.fromJson(String)