@Generated public class Field70G extends Field implements Serializable, GenericField, MultiLineField
String
String
String
String
String
String
String
String
String
String
String
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENTS_PATTERN |
static Integer |
CONDITIONAL_QUALIFIER
Component number for the conditional qualifier subfield
|
static String |
F_70G
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 70G
|
static Integer |
NARRATIVE
Component number for the Narrative subfield
|
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 |
---|
Field70G()
Default constructor.
|
Field70G(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field70G(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 Field70G |
get(SwiftMessage msg)
Get the first instance of Field70G in the given message.
|
static Field70G |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field70G> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field70G in the given message
an empty list is returned if none found.
|
static List<Field70G> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field70G from the given block
an empty list is returned if none found.
|
String |
getComponent1()
Get the component1
|
String |
getComponent10()
Get the component10
|
String |
getComponent10AsString()
Deprecated.
|
String |
getComponent11()
Get the component11
|
String |
getComponent11AsString()
Deprecated.
|
String |
getComponent1AsString()
Deprecated.
|
String |
getComponent2()
Get the component2
|
String |
getComponent2AsString()
Deprecated.
|
String |
getComponent3()
Get the component3
|
String |
getComponent3AsString()
Deprecated.
|
String |
getComponent4()
Get the component4
|
String |
getComponent4AsString()
Deprecated.
|
String |
getComponent5()
Get the component5
|
String |
getComponent5AsString()
Deprecated.
|
String |
getComponent6()
Get the component6
|
String |
getComponent6AsString()
Deprecated.
|
String |
getComponent7()
Get the component7
|
String |
getComponent7AsString()
Deprecated.
|
String |
getComponent8()
Get the component8
|
String |
getComponent8AsString()
Deprecated.
|
String |
getComponent9()
Get the component9
|
String |
getComponent9AsString()
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 |
getNarrative()
Get the Narrative as a concatenation of component2 to component11.
|
String |
getNarrativeLine1()
Get the Narrative (component2).
|
String |
getNarrativeLine10()
Get the Narrative (component11).
|
String |
getNarrativeLine2()
Get the Narrative (component3).
|
String |
getNarrativeLine3()
Get the Narrative (component4).
|
String |
getNarrativeLine4()
Get the Narrative (component5).
|
String |
getNarrativeLine5()
Get the Narrative (component6).
|
String |
getNarrativeLine6()
Get the Narrative (component7).
|
String |
getNarrativeLine7()
Get the Narrative (component8).
|
String |
getNarrativeLine8()
Get the Narrative (component9).
|
String |
getNarrativeLine9()
Get the Narrative (component10).
|
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 Field70G |
newInstance(Field70G 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() |
Field70G |
setComponent1(String component1)
Set the component1.
|
Field70G |
setComponent10(String component10)
Set the component10.
|
Field70G |
setComponent11(String component11)
Set the component11.
|
Field70G |
setComponent2(String component2)
Set the component2.
|
Field70G |
setComponent3(String component3)
Set the component3.
|
Field70G |
setComponent4(String component4)
Set the component4.
|
Field70G |
setComponent5(String component5)
Set the component5.
|
Field70G |
setComponent6(String component6)
Set the component6.
|
Field70G |
setComponent7(String component7)
Set the component7.
|
Field70G |
setComponent8(String component8)
Set the component8.
|
Field70G |
setComponent9(String component9)
Set the component9.
|
Field70G |
setNarrative(String value)
Set the Narrative splitting the parameter lines into components 2 to 11.
|
Field70G |
setNarrativeLine1(String component2)
Set the Narrative (component2).
|
Field70G |
setNarrativeLine10(String component11)
Set the Narrative (component11).
|
Field70G |
setNarrativeLine2(String component3)
Set the Narrative (component3).
|
Field70G |
setNarrativeLine3(String component4)
Set the Narrative (component4).
|
Field70G |
setNarrativeLine4(String component5)
Set the Narrative (component5).
|
Field70G |
setNarrativeLine5(String component6)
Set the Narrative (component6).
|
Field70G |
setNarrativeLine6(String component7)
Set the Narrative (component7).
|
Field70G |
setNarrativeLine7(String component8)
Set the Narrative (component8).
|
Field70G |
setNarrativeLine8(String component9)
Set the Narrative (component9).
|
Field70G |
setNarrativeLine9(String component10)
Set the Narrative (component10).
|
Field70G |
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_70G
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer QUALIFIER
public static final Integer NARRATIVE
public static final Integer CONDITIONAL_QUALIFIER
public Field70G()
public Field70G(String value)
value
- complete field value including separators and CRLFpublic Field70G(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 Field70G newInstance(Field70G 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 Field70G setComponent1(String component1)
component1
- the component1 to setpublic Field70G setQualifier(String component1)
component1
- the Qualifier to setpublic String getComponent2()
@Deprecated public String getComponent2AsString()
public String getNarrativeLine1()
public String getNarrativeLine2()
public String getNarrativeLine3()
public String getNarrativeLine4()
public String getNarrativeLine5()
public String getNarrativeLine6()
public String getNarrativeLine7()
public String getNarrativeLine8()
public String getNarrativeLine9()
public String getNarrativeLine10()
public String getNarrative()
public Field70G setComponent2(String component2)
component2
- the component2 to setpublic Field70G setNarrativeLine1(String component2)
component2
- the Narrative to setpublic Field70G setNarrativeLine2(String component3)
component3
- the Narrative to setpublic Field70G setNarrativeLine3(String component4)
component4
- the Narrative to setpublic Field70G setNarrativeLine4(String component5)
component5
- the Narrative to setpublic Field70G setNarrativeLine5(String component6)
component6
- the Narrative to setpublic Field70G setNarrativeLine6(String component7)
component7
- the Narrative to setpublic Field70G setNarrativeLine7(String component8)
component8
- the Narrative to setpublic Field70G setNarrativeLine8(String component9)
component9
- the Narrative to setpublic Field70G setNarrativeLine9(String component10)
component10
- the Narrative to setpublic Field70G setNarrativeLine10(String component11)
component11
- the Narrative to setpublic Field70G setNarrative(String value)
value
- the Narrative to set, may contain line ends and each line will be set to its correspondent component attributepublic String getComponent3()
@Deprecated public String getComponent3AsString()
public Field70G setComponent3(String component3)
component3
- the component3 to setpublic String getComponent4()
@Deprecated public String getComponent4AsString()
public Field70G setComponent4(String component4)
component4
- the component4 to setpublic String getComponent5()
@Deprecated public String getComponent5AsString()
public Field70G setComponent5(String component5)
component5
- the component5 to setpublic String getComponent6()
@Deprecated public String getComponent6AsString()
public Field70G setComponent6(String component6)
component6
- the component6 to setpublic String getComponent7()
@Deprecated public String getComponent7AsString()
public Field70G setComponent7(String component7)
component7
- the component7 to setpublic String getComponent8()
@Deprecated public String getComponent8AsString()
public Field70G setComponent8(String component8)
component8
- the component8 to setpublic String getComponent9()
@Deprecated public String getComponent9AsString()
public Field70G setComponent9(String component9)
component9
- the component9 to setpublic String getComponent10()
@Deprecated public String getComponent10AsString()
public Field70G setComponent10(String component10)
component10
- the component10 to setpublic String getComponent11()
@Deprecated public String getComponent11AsString()
public Field70G setComponent11(String component11)
component11
- the component11 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 Field70G get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field70G get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field70G> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field70G> 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)