public class Field17X extends Field implements Serializable
String
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENTS_PATTERN |
static String |
F_17X
same as NAME, intended to be clear when using static imports
|
static Integer |
INDICATOR
Component number for the Indicator subfield
|
static String |
NAME
Constant with the field name 17X
|
static String |
PARSER_PATTERN |
components
Constructor and Description |
---|
Field17X()
Default constructor
|
Field17X(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 Field17X |
get(SwiftMessage msg)
Get the first instance of Field17X in the given message.
|
static Field17X |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field17X> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field17X in the given message
an empty list is returned if none found.
|
static List<Field17X> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field17X from the given block
an empty list is returned if none found.
|
String |
getComponent1()
Get the component1
|
String |
getComponent1AsString()
Deprecated.
|
String |
getIndicator()
Get the Indicator (component1).
|
String |
getName()
Deprecated.
use constant Field17X
|
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 Field17X |
newInstance(Field17X source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
String |
parserPattern() |
Field17X |
setComponent1(String component1)
Set the component1.
|
Field17X |
setIndicator(String component1)
Set the Indicator (component1).
|
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_17X
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer INDICATOR
public Field17X()
public Field17X(String value)
value
- public static Field17X newInstance(Field17X 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 getIndicator()
public Field17X setComponent1(String component1)
component1
- the component1 to setpublic Field17X setIndicator(String component1)
component1
- the Indicator 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 Field17X get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field17X get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field17X> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field17X> getAll(SwiftTagListBlock block)
block
- may be empty or null in which case an empty list is returnedpublic int componentsSize()
componentsSize
in class Field