com.prowidesoftware.swift.model.field

Class OptionSPartyField

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.OptionSPartyField

All Implemented Interfaces:

JsonSerializable, PatternContainer

Direct Known Subclasses:

Field95S

public abstract class OptionSPartyField
extends Field

Party

Subfields (components) Data types

1. String
2. String
3. String
4. String
5. String

Structure definition

• parser pattern: :S/[S]/S/S/S
• components pattern: SSSKS

Since:

7.11.0

Field Summary

Fields

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. Use typesPattern() instead
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

Fields inherited from class com.prowidesoftware.swift.model.field.Field

components

Constructor Summary

Constructors

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.

Method Summary

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	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

Methods inherited from class com.prowidesoftware.swift.model.field.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, validName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PARSER_PATTERN

public static final java.lang.String PARSER_PATTERN

See Also:

Constant Field Values

COMPONENTS_PATTERN

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public static final java.lang.String COMPONENTS_PATTERN

Deprecated. Use typesPattern() instead

See Also:

Constant Field Values

TYPES_PATTERN

public static final java.lang.String TYPES_PATTERN

Types pattern Contains a description of the type of each component

See Also:

Constant Field Values

QUALIFIER

public static final java.lang.Integer QUALIFIER

Component number for the Qualifier subfield

DATA_SOURCE_SCHEME

public static final java.lang.Integer DATA_SOURCE_SCHEME

Component number for the Data Source Scheme subfield

TYPE_OF_ID

public static final java.lang.Integer TYPE_OF_ID

Component number for the Type Of ID subfield

COUNTRY_CODE

public static final java.lang.Integer COUNTRY_CODE

Component number for the Country Code subfield

ALTERNATE_ID

public static final java.lang.Integer ALTERNATE_ID

Component number for the Alternate ID subfield

Constructor Detail

OptionSPartyField

public OptionSPartyField()

Default constructor. Creates a new field setting all components to null.

OptionSPartyField

public OptionSPartyField(java.lang.String value)

Creates a new field and initializes its components with content from the parameter value.

Parameters:

value - complete field value including separators and CRLF

Method Detail

parse

public void parse(java.lang.String value)

Parses the parameter value into the internal components structure.

Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.

Specified by:

parse in class Field

Parameters:

value - complete field value including separators and CRLF

Since:

7.8

getValue

public java.lang.String getValue()

Serializes the fields' components into the single string value (SWIFT format)

Specified by:

getValue in class Field

Returns:

SWIFT formatted value

getValueDisplay

public java.lang.String getValueDisplay(int component,
                                        java.util.Locale locale)

Returns a localized suitable for showing to humans string of a field component.

Specified by:

getValueDisplay in class Field

Parameters:

component - number of the component to display

locale - optional locale to format date and amounts, if null, the default locale is used

Returns:

formatted component value or null if component number is invalid or not present

Throws:

java.lang.IllegalArgumentException - if component number is invalid for the field

Since:

7.8

componentsPattern

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public final java.lang.String componentsPattern()

Deprecated. Use typesPattern() instead

Specified by:

componentsPattern in class Field

typesPattern

public final java.lang.String typesPattern()

Returns the field component types pattern This method returns a letter representing the type for each component in the Field. It supersedes the Components Pattern because it distinguishes between N (Number) and I (BigDecimal).

Specified by:

typesPattern in interface PatternContainer

Specified by:

typesPattern in class Field

Returns:

the static value of TYPES_PATTERN

See Also:

TYPES_PATTERN

parserPattern

public final java.lang.String parserPattern()

Returns the field parser pattern

Returns:

the static value of PARSER_PATTERN

validatorPattern

public abstract java.lang.String validatorPattern()

Returns the field validator pattern, that could vary er specific field

Specified by:

validatorPattern in class Field

isOptional

public 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.

Specified by:

isOptional in class Field

Parameters:

component - component number, first component of a field is referenced as 1

Returns:

true if the component is optional for this field, false otherwise

isGeneric

public boolean isGeneric()

Returns true if the field is a GENERIC FIELD as specified by the standard.

Specified by:

isGeneric in class Field

Returns:

true if the field is generic, false otherwise

componentsSize

public 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.

Specified by:

componentsSize in class Field

Since:

7.7

getComponentLabels

public java.util.List<java.lang.String> getComponentLabels()

Returns english label for components.
The index in the list is in sync with specific field component structure.

Specified by:

getComponentLabels in class Field

Since:

7.8.4

See Also:

Field.getComponentLabel(int)

getComponentMap

protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()

Returns a mapping between component numbers and their label in camel case format.

Specified by:

getComponentMap in class Field

Since:

7.10.3

getName

public abstract java.lang.String getName()

Description copied from class: Field

Returns the field's name composed by the field number and the letter option (if any)

Specified by:

getName in class Field

Returns:

the specific field name (number and letter option)

getComponent1

public java.lang.String getComponent1()

Gets the component1 (Qualifier).

Returns:

the component1

getQualifier

public java.lang.String getQualifier()

Gets the Qualifier (component1).

Returns:

the Qualifier from component1

getComponent2

public java.lang.String getComponent2()

Gets the component2 (Data Source Scheme).

Returns:

the component2

getDataSourceScheme

public java.lang.String getDataSourceScheme()

Gets the Data Source Scheme (component2).

Returns:

the Data Source Scheme from component2

getComponent3

public java.lang.String getComponent3()

Gets the component3 (Type Of ID).

Returns:

the component3

getTypeOfID

public java.lang.String getTypeOfID()

Gets the Type Of ID (component3).

Returns:

the Type Of ID from component3

getComponent4

public java.lang.String getComponent4()

Gets the component4 (Country Code).

Returns:

the component4

getCountryCode

public java.lang.String getCountryCode()

Gets the Country Code (component4).

Returns:

the Country Code from component4

getComponent5

public java.lang.String getComponent5()

Gets the component5 (Alternate ID).

Returns:

the component5

getAlternateID

public java.lang.String getAlternateID()

Gets the Alternate ID (component5).

Returns:

the Alternate ID from component5