@Generated public class Field14G extends Field implements Serializable
String
String
1a/8!a
S/S
SS
This class complies with standard release SRU2017
NOTE: this source code has been generated from template
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENTS_PATTERN |
static String |
F_14G
same as NAME, intended to be clear when using static imports
|
static Integer |
FREQUENCY
Component number for the Frequency subfield
|
static Integer |
METHOD
Component number for the Method subfield
|
static String |
NAME
Constant with the field name 14G
|
static String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field14G()
Default constructor.
|
Field14G(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field14G(Tag tag)
Creates a new field and initializes its components with content from the parameter tag.
|
Modifier and Type | Method and Description |
---|---|
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. |
static Tag |
emptyTag()
Create a Tag with this field name and an empty string as value
Shorthand for
new Tag(NAME, "") |
static Field14G |
get(SwiftMessage msg)
Get the first instance of Field14G in the given message.
|
static Field14G |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field14G> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field14G in the given message
an empty list is returned if none found.
|
static List<Field14G> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field14G from the given block
an empty list is returned if none found.
|
String |
getComponent1()
Get the component1
|
String |
getComponent1AsString()
Deprecated.
use
Field.getComponent(int) instead |
String |
getComponent2()
Get the component2
|
String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getFrequency()
Get the Frequency (component1).
|
String |
getMethod()
Get the Method (component2).
|
String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
String |
getValueDisplay(int component,
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 Field14G |
newInstance(Field14G source)
Copy constructor.
Initializes the components list with a deep copy of the source components list. |
void |
parse(String value)
Parses the parameter value into the internal components structure.
|
String |
parserPattern() |
Field14G |
setComponent1(String component1)
Set the component1.
|
Field14G |
setComponent2(String component2)
Set the component2.
|
Field14G |
setFrequency(String component1)
Set the Frequency (component1).
|
Field14G |
setMethod(String component2)
Set the Method (component2).
|
static Tag |
tag(String value)
Create a Tag with this field name and the given value.
|
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, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toString, validName
public static final int SRU
public static final String NAME
public static final String F_14G
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer FREQUENCY
public static final Integer METHOD
public Field14G()
public Field14G(String value)
value
- complete field value including separators and CRLFpublic Field14G(Tag tag)
parse(String)
IllegalArgumentException
- if the parameter tag is null or its tagname does not match the field namepublic void parse(String value)
public static Field14G newInstance(Field14G 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 @ProwideDeprecated(phase2=_2018) public String getComponent1AsString()
Field.getComponent(int)
insteadpublic String getFrequency()
public Field14G setComponent1(String component1)
component1
- the component1 to setpublic Field14G setFrequency(String component1)
component1
- the Frequency to setpublic String getComponent2()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent2AsString()
Field.getComponent(int)
insteadpublic String getMethod()
public Field14G setComponent2(String component2)
component2
- the component2 to setpublic Field14G setMethod(String component2)
component2
- the Method 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 parserPattern()
parserPattern
in interface PatternContainer
public String getName()
public final String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final String validatorPattern()
validatorPattern
in class Field
public static Field14G get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field14G get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field14G> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field14G> 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 getValueDisplay(int component, 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 usedIllegalArgumentException
- if component number is invalid for the fieldprotected List<String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)