@Generated public class Field130 extends Field implements Serializable, MultiLineField
Number
String
Number
String
/2!n/65x$/2!n/65x
/S/S$/S/S
NSNS
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_130
same as NAME, intended to be clear when using static imports
|
static Integer |
HEADING_CODE
Component number for the Heading Code subfield
|
static Integer |
HEADING_CODE_2
Component number for the Heading Code 2 subfield
|
static Integer |
HEADING_TEXT
Component number for the Heading Text subfield
|
static Integer |
HEADING_TEXT_2
Component number for the Heading Text 2 subfield
|
static String |
NAME
Constant with the field name 130
|
static String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field130()
Default constructor.
|
Field130(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field130(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 Field130 |
get(SwiftMessage msg)
Get the first instance of Field130 in the given message.
|
static Field130 |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
static List<Field130> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field130 in the given message
an empty list is returned if none found.
|
static List<Field130> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field130 from the given block
an empty list is returned if none found.
|
String |
getComponent1()
Get the component1
|
Number |
getComponent1AsNumber()
Get the component1 as Number
|
String |
getComponent2()
Get the component2
|
String |
getComponent2AsString()
Deprecated.
use
Field.getComponent(int) instead |
String |
getComponent3()
Get the component3
|
Number |
getComponent3AsNumber()
Get the component3 as Number
|
String |
getComponent4()
Get the component4
|
String |
getComponent4AsString()
Deprecated.
use
Field.getComponent(int) instead |
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getHeadingCode()
Get the Heading Code (component1).
|
String |
getHeadingCode2()
Get the Heading Code 2 (component3).
|
Number |
getHeadingCode2AsNumber()
Get the Heading Code 2 (component3) as Number
|
Number |
getHeadingCodeAsNumber()
Get the Heading Code (component1) as Number
|
String |
getHeadingText()
Get the Heading Text (component2).
|
String |
getHeadingText2()
Get the Heading Text 2 (component4).
|
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 |
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 Field130 |
newInstance(Field130 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() |
Field130 |
setComponent1(Number component1)
Set the component1 from a Number object.
|
Field130 |
setComponent1(String component1)
Set the component1.
|
Field130 |
setComponent2(String component2)
Set the component2.
|
Field130 |
setComponent3(Number component3)
Set the component3 from a Number object.
|
Field130 |
setComponent3(String component3)
Set the component3.
|
Field130 |
setComponent4(String component4)
Set the component4.
|
Field130 |
setHeadingCode(Number component1)
Set the Heading Code (component1) from a Number object.
|
Field130 |
setHeadingCode(String component1)
Set the Heading Code (component1).
|
Field130 |
setHeadingCode2(Number component3)
Set the Heading Code 2 (component3) from a Number object.
|
Field130 |
setHeadingCode2(String component3)
Set the Heading Code 2 (component3).
|
Field130 |
setHeadingText(String component2)
Set the Heading Text (component2).
|
Field130 |
setHeadingText2(String component4)
Set the Heading Text 2 (component4).
|
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_130
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer HEADING_CODE
public static final Integer HEADING_TEXT
public static final Integer HEADING_CODE_2
public static final Integer HEADING_TEXT_2
public Field130()
public Field130(String value)
value
- complete field value including separators and CRLFpublic Field130(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 Field130 newInstance(Field130 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()
public Number getComponent1AsNumber()
null
if cannot be convertedpublic String getHeadingCode()
public Number getHeadingCodeAsNumber()
null
if cannot be convertedpublic Field130 setComponent1(String component1)
component1
- the component1 to setpublic Field130 setComponent1(Number component1)
component1
- the Number with the component1 content to setsetComponent1(String)
public Field130 setHeadingCode(String component1)
component1
- the Heading Code to setpublic Field130 setHeadingCode(Number component1)
component1
- Number with the Heading Code content to setsetComponent1(java.lang.Number)
public String getComponent2()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent2AsString()
Field.getComponent(int)
insteadpublic String getHeadingText()
public Field130 setComponent2(String component2)
component2
- the component2 to setpublic Field130 setHeadingText(String component2)
component2
- the Heading Text to setpublic String getComponent3()
public Number getComponent3AsNumber()
null
if cannot be convertedpublic String getHeadingCode2()
public Number getHeadingCode2AsNumber()
null
if cannot be convertedpublic Field130 setComponent3(String component3)
component3
- the component3 to setpublic Field130 setComponent3(Number component3)
component3
- the Number with the component3 content to setsetComponent3(String)
public Field130 setHeadingCode2(String component3)
component3
- the Heading Code 2 to setpublic Field130 setHeadingCode2(Number component3)
component3
- Number with the Heading Code 2 content to setsetComponent3(java.lang.Number)
public String getComponent4()
@Deprecated @ProwideDeprecated(phase2=_2018) public String getComponent4AsString()
Field.getComponent(int)
insteadpublic String getHeadingText2()
public Field130 setComponent4(String component4)
component4
- the component4 to setpublic Field130 setHeadingText2(String component4)
component4
- the Heading Text 2 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 Field130 get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field130 get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field130> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field130> 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)