public abstract class OptionDPartyField extends Field
Subfields (components) Data types
String
String
String
String
String
String
Structure definition
[[/c][/S]$]S[$S]0-3
SSSSSS
Modifier and Type | Field and Description |
---|---|
static java.lang.Integer |
ACCOUNT
Component number for the Account subfield
|
static java.lang.String |
COMPONENTS_PATTERN |
static java.lang.Integer |
DC_MARK
Component number for the D/C Mark subfield
|
static java.lang.Integer |
NAME_AND_ADDRESS
Component number for the Name And Address subfield
|
static java.lang.String |
PARSER_PATTERN |
components
Constructor and Description |
---|
OptionDPartyField()
Default constructor.
|
OptionDPartyField(java.lang.String value)
Creates a new field and initializes its components with content from the parameter value.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
componentsPattern()
Returns the field 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. |
java.lang.String |
getAccount()
Gets the Account (component2) removing its starting slashes if any.
|
java.lang.String |
getComponent1()
Gets the component1 (D/C Mark).
|
java.lang.String |
getComponent2()
Gets the component2 (Account).
|
java.lang.String |
getComponent3()
Gets the component3 (Name And Address).
|
java.lang.String |
getComponent4()
Gets the component4 (Name And Address).
|
java.lang.String |
getComponent5()
Gets the component5 (Name And Address).
|
java.lang.String |
getComponent6()
Gets the component6 (Name And Address).
|
protected java.util.List<java.lang.String> |
getComponentLabels()
Returns english label for components.
|
protected java.util.Map<java.lang.Integer,java.lang.String> |
getComponentMap()
Returns a mapping between component numbers and their label in camel case format.
|
java.lang.String |
getDCMark()
Gets the D/C Mark (component1).
|
abstract java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getNameAndAddress()
Gets the Name And Address as a concatenation of component3 to component6.
|
java.lang.String |
getNameAndAddressLine1()
Gets the Name And Address (component3).
|
java.lang.String |
getNameAndAddressLine2()
Gets the Name And Address (component4).
|
java.lang.String |
getNameAndAddressLine3()
Gets the Name And Address (component5).
|
java.lang.String |
getNameAndAddressLine4()
Gets the Name And Address (component6).
|
java.lang.String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
java.lang.String |
getValueDisplay(int component,
java.util.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. |
void |
parse(java.lang.String value)
Parses the parameter value into the internal components structure.
|
java.lang.String |
parserPattern()
Returns the field parser pattern
|
abstract java.lang.String |
validatorPattern()
Returns the field validator pattern, that could vary er specific field
|
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, fromJson, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toJson, toString, validName
public static final java.lang.String PARSER_PATTERN
public static final java.lang.String COMPONENTS_PATTERN
public static final java.lang.Integer DC_MARK
public static final java.lang.Integer ACCOUNT
public static final java.lang.Integer NAME_AND_ADDRESS
public OptionDPartyField()
public OptionDPartyField(java.lang.String value)
value
- complete field value including separators and CRLFpublic void parse(java.lang.String value)
Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
public java.lang.String getValue()
public java.lang.String getValueDisplay(int component, java.util.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 usedjava.lang.IllegalArgumentException
- if component number is invalid for the fieldpublic final java.lang.String componentsPattern()
componentsPattern
in interface PatternContainer
componentsPattern
in class Field
public final java.lang.String parserPattern()
public abstract java.lang.String validatorPattern()
validatorPattern
in class Field
public boolean isOptional(int component)
isOptional
in class Field
component
- component number, first component of a field is referenced as 1public boolean isGeneric()
public int componentsSize()
componentsSize
in class Field
protected java.util.List<java.lang.String> getComponentLabels()
getComponentLabels
in class Field
Field.getComponentLabel(int)
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
getComponentMap
in class Field
public abstract java.lang.String getName()
Field
public java.lang.String getComponent1()
public java.lang.String getDCMark()
public java.lang.String getComponent2()
public java.lang.String getAccount()
public java.lang.String getComponent3()
public java.lang.String getNameAndAddressLine1()
public java.lang.String getNameAndAddressLine2()
public java.lang.String getNameAndAddressLine3()
public java.lang.String getNameAndAddressLine4()
public java.lang.String getNameAndAddress()
public java.lang.String getComponent4()
public java.lang.String getComponent5()
public java.lang.String getComponent6()