@Generated public class Field94G extends Field implements Serializable, GenericField, MultiLineField
String
String
String
Modifier and Type | Field and Description |
---|---|
static Integer |
ADDRESS
Component number for the Address subfield
|
static String |
COMPONENTS_PATTERN |
static Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield
|
static String |
F_94G
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 94G
|
static String |
PARSER_PATTERN |
static Integer |
QUALIFIER
Component number for the Qualifier subfield
|
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field94G()
Default constructor.
|
Field94G(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field94G(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 Field94G |
get(SwiftMessage msg)
Get the first instance of Field94G in the given message.
|
static Field94G |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
String |
getAddress()
Get the Address as a concatenation of component2 to component3.
|
String |
getAddressLine1()
Get the Address (component2).
|
String |
getAddressLine2()
Get the Address (component3).
|
static List<Field94G> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field94G in the given message
an empty list is returned if none found.
|
static List<Field94G> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field94G from the given block
an empty list is returned if none found.
|
String |
getComponent1()
Get the component1
|
String |
getComponent1AsString()
Deprecated.
|
String |
getComponent2()
Get the component2
|
String |
getComponent2AsString()
Deprecated.
|
String |
getComponent3()
Get the component3
|
String |
getComponent3AsString()
Deprecated.
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getConditionalQualifier()
Gets the conditional qualifier.
The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition. |
String |
getDSS()
Returns the issuer code (or Data Source Scheme or DSS).
|
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()
Returns the field's name composed by the field number and the letter option (if any)
|
String |
getQualifier()
Get the Qualifier (component1).
|
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 |
isDSSPresent()
Checks if the issuer code (or Data Source Scheme or DSS) is present.
|
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 Field94G |
newInstance(Field94G 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() |
Field94G |
setAddress(String value)
Set the Address splitting the parameter lines into components 2 to 3.
|
Field94G |
setAddressLine1(String component2)
Set the Address (component2).
|
Field94G |
setAddressLine2(String component3)
Set the Address (component3).
|
Field94G |
setComponent1(String component1)
Set the component1.
|
Field94G |
setComponent2(String component2)
Set the component2.
|
Field94G |
setComponent3(String component3)
Set the component3.
|
Field94G |
setQualifier(String component1)
Set the Qualifier (component1).
|
static Tag |
tag(String value)
Create a Tag with this field name and the given value.
|
String |
validatorPattern()
Returns the field's validators pattern
|
appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, isAnyOf, 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_94G
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer QUALIFIER
public static final Integer ADDRESS
public static final Integer CONDITIONAL_QUALIFIER
public Field94G()
public Field94G(String value)
value
- complete field value including separators and CRLFpublic Field94G(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 Field94G newInstance(Field94G 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 getQualifier()
public Field94G setComponent1(String component1)
component1
- the component1 to setpublic Field94G setQualifier(String component1)
component1
- the Qualifier to setpublic String getComponent2()
@Deprecated public String getComponent2AsString()
public String getAddressLine1()
public String getAddressLine2()
public String getAddress()
public Field94G setComponent2(String component2)
component2
- the component2 to setpublic Field94G setAddressLine1(String component2)
component2
- the Address to setpublic Field94G setAddressLine2(String component3)
component3
- the Address to setpublic Field94G setAddress(String value)
value
- the Address to set, may contain line ends and each line will be set to its correspondent component attributepublic String getComponent3()
@Deprecated public String getComponent3AsString()
public Field94G setComponent3(String component3)
component3
- the component3 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 getDSS()
getDSS
in interface GenericField
getDSS
in class Field
null
if the DSS is not set or not available for this field.public boolean isDSSPresent()
isDSSPresent
in interface GenericField
isDSSPresent
in class Field
getDSS()
public String getConditionalQualifier()
getConditionalQualifier
in interface GenericField
getConditionalQualifier
in class Field
null
if not set or not applicable for this kind of field.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 Field94G get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field94G get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field94G> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field94G> 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)
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, int )
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)
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)