@Generated public class Field11S extends Field implements java.io.Serializable, DateContainer, MultiLineField
Number
Calendar
Number
Number
<MT>$<DATE2>[$4!n6!n]
S$<DATE2>[$4!S6!S]
MENN
This class complies with standard release SRU2017
NOTE: this source code has been generated from template
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
DATE
Component number for the Date subfield
|
static java.lang.String |
F_11S
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
Component number for the MT subfield
|
static java.lang.String |
NAME
Constant with the field name 11S
|
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.
|
components
Constructor and Description |
---|
Field11S()
Default constructor.
|
Field11S(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field11S(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()
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. |
java.util.List<java.util.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 Field11S |
get(SwiftMessage msg)
Get the first instance of Field11S in the given message.
|
static Field11S |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static java.util.List<Field11S> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field11S in the given message
an empty list is returned if none found.
|
static java.util.List<Field11S> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field11S from the given block
an empty list is returned if none found.
|
java.lang.String |
getComponent1()
Get the component1
|
java.lang.String |
getComponent2()
Get the component2
|
java.util.Calendar |
getComponent2AsCalendar()
Get the component2 as Calendar
|
java.lang.String |
getComponent3()
Get the component3
|
java.lang.Number |
getComponent3AsNumber()
Get the component3 as Number
|
java.lang.String |
getComponent4()
Get the component4
|
java.lang.Number |
getComponent4AsNumber()
Get the component4 as Number
|
protected java.util.List<java.lang.String> |
getComponentLabels()
Returns english label for components.
|
java.lang.String |
getDate()
Get the Date (component2).
|
java.util.Calendar |
getDateAsCalendar()
Get the Date (component2) as Calendar
|
java.lang.String |
getISN()
Get the ISN (component4).
|
java.lang.Number |
getISNAsNumber()
Get the ISN (component4) as Number
|
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()
Get the MT (component1).
|
java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getSessionNumber()
Get the Session Number (component3).
|
java.lang.Number |
getSessionNumberAsNumber()
Get the Session Number (component3) as Number
|
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 Field11S |
newInstance(Field11S 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() |
Field11S |
setComponent1(java.lang.String component1)
Set the component1.
|
Field11S |
setComponent2(java.util.Calendar component2)
Set the component2 from a Calendar object.
|
Field11S |
setComponent2(java.lang.String component2)
Set the component2.
|
Field11S |
setComponent3(java.lang.Number component3)
Set the component3 from a Number object.
|
Field11S |
setComponent3(java.lang.String component3)
Set the component3.
|
Field11S |
setComponent4(java.lang.Number component4)
Set the component4 from a Number object.
|
Field11S |
setComponent4(java.lang.String component4)
Set the component4.
|
Field11S |
setDate(java.util.Calendar component2)
Set the Date (component2) from a Calendar object.
|
Field11S |
setDate(java.lang.String component2)
Set the Date (component2).
|
Field11S |
setISN(java.lang.Number component4)
Set the ISN (component4) from a Number object.
|
Field11S |
setISN(java.lang.String component4)
Set the ISN (component4).
|
Field11S |
setMT(java.lang.String component1)
Set the MT (component1).
|
Field11S |
setSessionNumber(java.lang.Number component3)
Set the Session Number (component3) from a Number object.
|
Field11S |
setSessionNumber(java.lang.String component3)
Set the Session Number (component3).
|
static Tag |
tag(java.lang.String value)
Create a Tag with this field name and the given value.
|
java.lang.String |
validatorPattern()
Returns the field's validators pattern
|
append, 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, is, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toString, validName
public static final int SRU
public static final java.lang.String NAME
public static final java.lang.String F_11S
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer MT
public static final java.lang.Integer DATE
public static final java.lang.Integer SESSION_NUMBER
public static final java.lang.Integer ISN
public Field11S()
public Field11S(java.lang.String value)
value
- complete field value including separators and CRLFpublic Field11S(Tag tag)
parse(String)
java.lang.IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic void parse(java.lang.String value)
public static Field11S newInstance(Field11S source)
source
- a field instance to copypublic java.lang.String getValue()
public static Tag tag(java.lang.String value)
new Tag(NAME, value)
NAME
public static Tag emptyTag()
new Tag(NAME, "")
NAME
public java.lang.String getComponent1()
public java.lang.String getMT()
public Field11S setComponent1(java.lang.String component1)
component1
- the component1 to setpublic Field11S setMT(java.lang.String component1)
component1
- the MT to setpublic java.lang.String getComponent2()
public java.util.Calendar getComponent2AsCalendar()
null
if cannot be convertedpublic java.lang.String getDate()
public java.util.Calendar getDateAsCalendar()
null
if cannot be convertedpublic Field11S setComponent2(java.lang.String component2)
component2
- the component2 to setpublic Field11S setComponent2(java.util.Calendar component2)
component2
- the Calendar with the component2 content to setpublic Field11S setDate(java.lang.String component2)
component2
- the Date to setpublic Field11S setDate(java.util.Calendar component2)
component2
- Calendar with the Date content to setsetComponent2(java.util.Calendar)
public java.lang.String getComponent3()
public java.lang.Number getComponent3AsNumber()
null
if cannot be convertedpublic java.lang.String getSessionNumber()
public java.lang.Number getSessionNumberAsNumber()
null
if cannot be convertedpublic Field11S setComponent3(java.lang.String component3)
component3
- the component3 to setpublic Field11S setComponent3(java.lang.Number component3)
component3
- the Number with the component3 content to setsetComponent3(String)
public Field11S setSessionNumber(java.lang.String component3)
component3
- the Session Number to setpublic Field11S setSessionNumber(java.lang.Number component3)
component3
- Number with the Session Number content to setsetComponent3(java.lang.Number)
public java.lang.String getComponent4()
public java.lang.Number getComponent4AsNumber()
null
if cannot be convertedpublic java.lang.String getISN()
public java.lang.Number getISNAsNumber()
null
if cannot be convertedpublic Field11S setComponent4(java.lang.String component4)
component4
- the component4 to setpublic Field11S setComponent4(java.lang.Number component4)
component4
- the Number with the component4 content to setsetComponent4(String)
public Field11S setISN(java.lang.String component4)
component4
- the ISN to setpublic Field11S setISN(java.lang.Number component4)
component4
- Number with the ISN content to setsetComponent4(java.lang.Number)
public java.util.List<java.util.Calendar> dates()
DateContainer
dates
in interface DateContainer
public boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public java.lang.String parserPattern()
parserPattern
in interface PatternContainer
public java.lang.String getName()
public final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final java.lang.String validatorPattern()
validatorPattern
in class Field
public static Field11S get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field11S get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static java.util.List<Field11S> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static java.util.List<Field11S> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field
public 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 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 fieldprotected java.util.List<java.lang.String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)