public class Field77B extends Field implements Serializable, MultiLineField
String
String
String
Modifier and Type | Field and Description |
---|---|
static Integer |
CODE
Component number for the Code subfield
|
static String |
COMPONENTS_PATTERN |
static Integer |
COUNTRY_CODE
Component number for the Country Code subfield
|
static String |
F_77B
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 77B
|
static Integer |
NARRATIVE
Component number for the Narrative subfield
|
static String |
PARSER_PATTERN |
components
Constructor and Description |
---|
Field77B()
Default constructor
|
Field77B(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. |
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value
Shorthand for
new Tag(NAME, "") |
static Field77B |
get(SwiftMessage msg)
Get the first instance of Field77B in the given message.
|
static Field77B |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field77B> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field77B in the given message
an empty list is returned if none found.
|
static List<Field77B> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field77B from the given block
an empty list is returned if none found.
|
String |
getCode()
Get the Code (component1).
|
String |
getComponent1()
Get the component1
|
String |
getComponent1AsString()
Deprecated.
|
String |
getComponent2()
Get the component2
|
String |
getComponent2AsString()
Deprecated.
|
String |
getComponent3()
Get the component3
|
String |
getComponent3AsString()
Deprecated.
|
String |
getCountryCode()
Get the Country Code (component2).
|
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 |
getName()
Deprecated.
use constant Field77B
|
String |
getNarrative()
Get the Narrative (component3).
|
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 Field77B |
newInstance(Field77B source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
String |
parserPattern() |
Field77B |
setCode(String component1)
Set the Code (component1).
|
Field77B |
setComponent1(String component1)
Set the component1.
|
Field77B |
setComponent2(String component2)
Set the component2.
|
Field77B |
setComponent3(String component3)
Set the component3.
|
Field77B |
setCountryCode(String component2)
Set the Country Code (component2).
|
Field77B |
setNarrative(String component3)
Set the Narrative (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_77B
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer CODE
public static final Integer COUNTRY_CODE
public static final Integer NARRATIVE
public Field77B()
public Field77B(String value)
value
- public static Field77B newInstance(Field77B 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 getCode()
public Field77B setComponent1(String component1)
component1
- the component1 to setpublic Field77B setCode(String component1)
component1
- the Code to setpublic String getComponent2()
@Deprecated public String getComponent2AsString()
public String getCountryCode()
public Field77B setComponent2(String component2)
component2
- the component2 to setpublic Field77B setCountryCode(String component2)
component2
- the Country Code to setpublic String getComponent3()
@Deprecated public String getComponent3AsString()
public String getNarrative()
public Field77B setComponent3(String component3)
component3
- the component3 to setpublic Field77B setNarrative(String component3)
component3
- the Narrative to setpublic 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 Field77B get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field77B get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field77B> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field77B> 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)}