public class Field11S extends Field implements Serializable, DateContainer, MultiLineField
Number
Calendar
Number
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENTS_PATTERN |
static Integer |
DATE
Component number for the Date subfield
|
static String |
F_11S
same as NAME, intended to be clear when using static imports
|
static Integer |
MT
Component number for the MT subfield
|
static String |
NAME
Constant with the field name 11S
|
static Integer |
NUMBER
Component number for the Number subfield
|
static String |
PARSER_PATTERN |
components
Constructor and Description |
---|
Field11S()
Default constructor
|
Field11S(String value)
Creates the field parsing the parameter value into fields' components
|
Modifier and Type | Method and Description |
---|---|
String |
componentsPattern() |
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 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 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 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.
|
String |
getComponent1()
Get the component1
|
String |
getComponent2()
Get the component2
|
Calendar |
getComponent2AsCalendar()
Get the component2 as Calendar
|
String |
getComponent3()
Get the component3
|
Number |
getComponent3AsNumber()
Get the component3 as Number
|
String |
getDate()
Get the Date (component2).
|
Calendar |
getDateAsCalendar()
Get the Date (component2) as Calendar
|
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 |
getMT()
Get the MT (component1).
|
String |
getName()
Deprecated.
use constant Field11S
|
String |
getNumber()
Get the Number (component3).
|
Number |
getNumberAsNumber()
Get the Number (component3) as Number
|
String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
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. |
String |
parserPattern() |
Field11S |
setComponent1(String component1)
Set the component1.
|
Field11S |
setComponent2(Calendar component2)
Set the component2.
|
Field11S |
setComponent2(String component2)
Set the component2.
|
Field11S |
setComponent3(Number component3)
Set the component3.
|
Field11S |
setComponent3(String component3)
Set the component3.
|
Field11S |
setDate(Calendar component2)
Set the Date (component2) as Calendar
|
Field11S |
setDate(String component2)
Set the Date (component2).
|
Field11S |
setMT(String component1)
Set the MT (component1).
|
Field11S |
setNumber(Number component3)
Set the Number (component3) as Number
|
Field11S |
setNumber(String component3)
Set the Number (component3).
|
static Tag |
tag(String value)
Create a Tag with this field name and the given value.
|
appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponents, getConditionalQualifier, getDSS, getField, getLabel, getLabel, getLabel, getLabel, getLine, getValueByCodeword, getValueDisplay, hashCode, is, is, is, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toString
public static final String NAME
public static final String F_11S
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer MT
public static final Integer DATE
public static final Integer NUMBER
public Field11S()
public Field11S(String value)
value
- public static Field11S newInstance(Field11S 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 String getMT()
public Field11S setComponent1(String component1)
component1
- the component1 to setpublic Field11S setMT(String component1)
component1
- the MT to setpublic String getComponent2()
public Calendar getComponent2AsCalendar()
null
if cannot be convertedpublic String getDate()
public Calendar getDateAsCalendar()
null
if cannot be convertedpublic Field11S setComponent2(String component2)
component2
- the component2 to setpublic Field11S setComponent2(Calendar component2)
component2
- the Calendar with the component2 content to setpublic Field11S setDate(String component2)
component2
- the Date to setpublic Field11S setDate(Calendar component2)
component2
- Calendar with the Date content to setpublic String getComponent3()
public Number getComponent3AsNumber()
null
if cannot be convertedpublic String getNumber()
public Number getNumberAsNumber()
null
if cannot be convertedpublic Field11S setComponent3(String component3)
component3
- the component3 to setpublic Field11S setComponent3(Number component3)
component3
- the Number with the component3 content to setpublic Field11S setNumber(String component3)
component3
- the Number to setpublic Field11S setNumber(Number component3)
component3
- Number with the Number content to setpublic List<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 String componentsPattern()
componentsPattern
in interface PatternContainer
public String parserPattern()
parserPattern
in interface PatternContainer
public String getName()
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 List<Field11S> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static 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 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 offset)}
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 start, int end)}
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)}