public abstract class OptionJPartyField extends Field
Subfields (components) Data types
String
Structure definition
S
S
Modifier and Type | Class and Description |
---|---|
static class |
OptionJPartyField.Codeword |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENTS_PATTERN
Deprecated.
Use
typesPattern() instead |
static java.lang.String |
PARSER_PATTERN |
static java.lang.Integer |
PARTY_IDENTIFICATION
Component number for the Party Identification subfield
|
static java.lang.String |
TYPES_PATTERN
Types pattern
Contains a description of the type of each component
|
components, labelMap
Constructor and Description |
---|
OptionJPartyField()
Default constructor.
|
OptionJPartyField(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.
Use
typesPattern() instead |
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 |
getComponent1()
Gets the component1 (Party Identification).
|
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.
|
protected java.util.Map<java.lang.String,java.lang.Integer> |
getLabelMap()
Returns a mapping between component labels and the internal component number.
|
abstract java.lang.String |
getName()
Returns the field's name composed by the field number and the letter option (if any)
|
java.lang.String |
getPartyIdentification()
Gets the Party Identification (component1).
|
java.lang.String |
getValue()
Serializes the fields' components into the single string value (SWIFT format)
|
java.lang.String |
getValueByCodeword(OptionJPartyField.Codeword codeword)
Returns the value following the parameter codeword or null if the codeword or its following value are not found.
|
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, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, fromJson, getAsBigDecimal, getComponent, getComponent, getComponentAs, getComponentAs, getComponentAsNumber, getComponentAsNumber, getComponentLabel, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponent, setComponents, toJson, toString, validName
public static final java.lang.String PARSER_PATTERN
@Deprecated @ProwideDeprecated(phase3=SRU2023) public static final java.lang.String COMPONENTS_PATTERN
typesPattern()
insteadpublic static final java.lang.String TYPES_PATTERN
public static final java.lang.Integer PARTY_IDENTIFICATION
public OptionJPartyField()
public OptionJPartyField(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 field@Deprecated @ProwideDeprecated(phase3=SRU2023) public final java.lang.String componentsPattern()
typesPattern()
insteadcomponentsPattern
in class Field
public final java.lang.String typesPattern()
typesPattern
in interface PatternContainer
typesPattern
in class Field
TYPES_PATTERN
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
public 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
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
Field
getLabelMap
in class Field
Field.getLabelMap()
public abstract java.lang.String getName()
Field
public java.lang.String getComponent1()
public java.lang.String getPartyIdentification()
public java.lang.String getValueByCodeword(OptionJPartyField.Codeword codeword)
For OptionJPartyField.Codeword.NETS
or OptionJPartyField.Codeword.SSIS
it will always return null, because those codewords cannot
be followed by a value. Breaking lines are ignored, meaning both codewords and values split along lines will be
joined before processing.
codeword
- a valid codeword to search