@Generated public class Field50D extends Field implements Serializable, MultiLineField
String
String
String
String
String
String
Modifier and Type | Field and Description |
---|---|
static Integer |
ACCOUNT
Component number for the Account subfield
|
static String |
COMPONENTS_PATTERN |
static Integer |
DC_MARK
Component number for the D/C Mark subfield
|
static String |
F_50D
same as NAME, intended to be clear when using static imports
|
static String |
NAME
Constant with the field name 50D
|
static Integer |
NAME_AND_ADDRESS
Component number for the Name And Address subfield
|
static String |
PARSER_PATTERN |
static int |
SRU
Constant identifying the SRU to which this class belongs to.
|
components
Constructor and Description |
---|
Field50D()
Default constructor.
|
Field50D(String value)
Creates a new field and initializes its components with content from the parameter value.
|
Field50D(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 Field50D |
get(SwiftMessage msg)
Get the first instance of Field50D in the given message.
|
static Field50D |
get(SwiftTagListBlock block)
Get the first occurrence form the tag list or null if not found.
|
String |
getAccount()
Get the Account (component2) removing its starting slashes if any.
|
static List<Field50D> |
getAll(SwiftMessage msg)
Get a list of all occurrences of the field Field50D in the given message
an empty list is returned if none found.
|
static List<Field50D> |
getAll(SwiftTagListBlock block)
Get a list of all occurrences of the field Field50D 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.
|
String |
getComponent4()
Get the component4
|
String |
getComponent4AsString()
Deprecated.
|
String |
getComponent5()
Get the component5
|
String |
getComponent5AsString()
Deprecated.
|
String |
getComponent6()
Get the component6
|
String |
getComponent6AsString()
Deprecated.
|
protected List<String> |
getComponentLabels()
Returns english label for components.
|
String |
getDCMark()
Get the D/C Mark (component1).
|
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 |
getNameAndAddress()
Get the Name And Address as a concatenation of component3 to component6.
|
String |
getNameAndAddressLine1()
Get the Name And Address (component3).
|
String |
getNameAndAddressLine2()
Get the Name And Address (component4).
|
String |
getNameAndAddressLine3()
Get the Name And Address (component5).
|
String |
getNameAndAddressLine4()
Get the Name And Address (component6).
|
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 Field50D |
newInstance(Field50D 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() |
Field50D |
setAccount(String component2)
Set the Account (component2).
|
Field50D |
setComponent1(String component1)
Set the component1.
|
Field50D |
setComponent2(String component2)
Set the component2.
|
Field50D |
setComponent3(String component3)
Set the component3.
|
Field50D |
setComponent4(String component4)
Set the component4.
|
Field50D |
setComponent5(String component5)
Set the component5.
|
Field50D |
setComponent6(String component6)
Set the component6.
|
Field50D |
setDCMark(String component1)
Set the D/C Mark (component1).
|
Field50D |
setNameAndAddress(String value)
Set the Name And Address splitting the parameter lines into components 3 to 6.
|
Field50D |
setNameAndAddressLine1(String component3)
Set the Name And Address (component3).
|
Field50D |
setNameAndAddressLine2(String component4)
Set the Name And Address (component4).
|
Field50D |
setNameAndAddressLine3(String component5)
Set the Name And Address (component5).
|
Field50D |
setNameAndAddressLine4(String component6)
Set the Name And Address (component6).
|
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, 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, setComponent, setComponents, toString, validName
public static final int SRU
public static final String NAME
public static final String F_50D
public static final String PARSER_PATTERN
public static final String COMPONENTS_PATTERN
public static final Integer DC_MARK
public static final Integer ACCOUNT
public static final Integer NAME_AND_ADDRESS
public Field50D()
public Field50D(String value)
value
- complete field value including separators and CRLFpublic Field50D(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 Field50D newInstance(Field50D 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 getDCMark()
public Field50D setComponent1(String component1)
component1
- the component1 to setpublic Field50D setDCMark(String component1)
component1
- the D/C Mark to setpublic String getComponent2()
@Deprecated public String getComponent2AsString()
public String getAccount()
public Field50D setComponent2(String component2)
component2
- the component2 to setpublic Field50D setAccount(String component2)
component2
- the Account to setpublic String getComponent3()
@Deprecated public String getComponent3AsString()
public String getNameAndAddressLine1()
public String getNameAndAddressLine2()
public String getNameAndAddressLine3()
public String getNameAndAddressLine4()
public String getNameAndAddress()
public Field50D setComponent3(String component3)
component3
- the component3 to setpublic Field50D setNameAndAddressLine1(String component3)
component3
- the Name And Address to setpublic Field50D setNameAndAddressLine2(String component4)
component4
- the Name And Address to setpublic Field50D setNameAndAddressLine3(String component5)
component5
- the Name And Address to setpublic Field50D setNameAndAddressLine4(String component6)
component6
- the Name And Address to setpublic Field50D setNameAndAddress(String value)
value
- the Name And Address to set, may contain line ends and each line will be set to its correspondent component attributepublic String getComponent4()
@Deprecated public String getComponent4AsString()
public Field50D setComponent4(String component4)
component4
- the component4 to setpublic String getComponent5()
@Deprecated public String getComponent5AsString()
public Field50D setComponent5(String component5)
component5
- the component5 to setpublic String getComponent6()
@Deprecated public String getComponent6AsString()
public Field50D setComponent6(String component6)
component6
- the component6 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 Field50D get(SwiftTagListBlock block)
block
- may be null or emptypublic static Field50D get(SwiftMessage msg)
msg
- may be empty or nullget(SwiftTagListBlock)
public static List<Field50D> getAll(SwiftMessage msg)
msg
- may be empty or null in which case an empty list is returnedgetAll(SwiftTagListBlock)
public static List<Field50D> 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)