public abstract class OptionSPartyField extends Field
Subfields (components) Data types
StringStringStringStringStringStructure definition
:S/[S]/S/S/SSSSKS| Modifier and Type | Field and Description |
|---|---|
static java.lang.Integer |
ALTERNATE_ID
Component number for the Alternate ID subfield
|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
|
static java.lang.Integer |
COUNTRY_CODE
Component number for the Country Code subfield
|
static java.lang.Integer |
DATA_SOURCE_SCHEME
Component number for the Data Source Scheme subfield
|
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
QUALIFIER
Component number for the Qualifier subfield
|
static java.lang.Integer |
TYPE_OF_ID
Component number for the Type Of ID subfield
|
static java.lang.String |
TYPES_PATTERN
Types pattern
Contains a description of the type of each component
|
components| Constructor and Description |
|---|
OptionSPartyField()
Default constructor.
|
OptionSPartyField(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()
Deprecated.
|
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 |
getAlternateID()
Gets the Alternate ID (component5).
|
java.lang.String |
getComponent1()
Gets the component1 (Qualifier).
|
java.lang.String |
getComponent2()
Gets the component2 (Data Source Scheme).
|
java.lang.String |
getComponent3()
Gets the component3 (Type Of ID).
|
java.lang.String |
getComponent4()
Gets the component4 (Country Code).
|
java.lang.String |
getComponent5()
Gets the component5 (Alternate ID).
|
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 |
getCountryCode()
Gets the Country Code (component4).
|
java.lang.String |
getDataSourceScheme()
Gets the Data Source Scheme (component2).
|
abstract java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getQualifier()
Gets the Qualifier (component1).
|
java.lang.String |
getTypeOfID()
Gets the Type Of ID (component3).
|
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
|
java.lang.String |
typesPattern()
Returns the field component types pattern
This method returns a letter representing the type for each component in the Field.
|
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, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toJson, toString, validNamepublic static final java.lang.String PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase2=SRU2022) public static final java.lang.String COMPONENTS_PATTERN
TYPES_PATTERN instead.TYPES_PATTERN,
Constant Field Valuespublic static final java.lang.String TYPES_PATTERN
public static final java.lang.Integer QUALIFIER
public static final java.lang.Integer DATA_SOURCE_SCHEME
public static final java.lang.Integer TYPE_OF_ID
public static final java.lang.Integer COUNTRY_CODE
public static final java.lang.Integer ALTERNATE_ID
public OptionSPartyField()
public OptionSPartyField(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 Fieldcomponent - 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 field@Deprecated @ProwideDeprecated(phase2=SRU2022) public final java.lang.String componentsPattern()
typesPattern() instead.componentsPattern in class FieldtypesPattern()public final java.lang.String typesPattern()
typesPattern in interface PatternContainertypesPattern in class FieldTYPES_PATTERNpublic final java.lang.String parserPattern()
public abstract java.lang.String validatorPattern()
validatorPattern in class Fieldpublic boolean isOptional(int component)
isOptional in class Fieldcomponent - component number, first component of a field is referenced as 1public boolean isGeneric()
public int componentsSize()
componentsSize in class Fieldpublic java.util.List<java.lang.String> getComponentLabels()
getComponentLabels in class FieldField.getComponentLabel(int)protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
getComponentMap in class Fieldpublic abstract java.lang.String getName()
Fieldpublic java.lang.String getComponent1()
public java.lang.String getQualifier()
public java.lang.String getComponent2()
public java.lang.String getDataSourceScheme()
public java.lang.String getComponent3()
public java.lang.String getTypeOfID()
public java.lang.String getComponent4()
public java.lang.String getCountryCode()
public java.lang.String getComponent5()
public java.lang.String getAlternateID()