com.prowidesoftware.swift.model.field

Class Field26C

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field26C

All Implemented Interfaces:

JsonSerializable, PatternContainer, java.io.Serializable

@Generated
public class Field26C
extends Field
implements java.io.Serializable

SWIFT MT Field 26C.

Model and parser for field 26C of a SWIFT MT message.

Subfields (components) Data types

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

Structure definition

• validation pattern: [3!a]/15x/5!a4!a<VAR-SEQU-4>
• parser pattern: [S]/S/5!a4!aS[//S]
• components pattern: SSSSSS

This class complies with standard release SRU2022

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	ALLOCATION Component number for the Allocation subfield.
static java.lang.String	COMPONENTS_PATTERN Deprecated. Use typesPattern() method instead.
static java.lang.Integer	DELIVERY_DETAILS Component number for the Delivery Details subfield.
static java.lang.Integer	DELIVERY_LOCATION Component number for the Delivery Location subfield.
static java.lang.Integer	DENOMINATION Component number for the Denomination subfield.
static java.lang.Integer	DENOMINATION_FORM Deprecated.
static java.lang.String	F_26C Same as NAME, intended to be clear when using static imports.
static java.lang.Integer	FORM Component number for the Form subfield.
static java.lang.String	NAME Constant with the field name 26C.
static java.lang.String	PARSER_PATTERN Deprecated. Use parserPattern() method instead.
static int	SRU Constant identifying the SRU to which this class belongs to.
static java.lang.Integer	TYPE Component number for the Type subfield.
static java.lang.String	TYPES_PATTERN Deprecated. Use typesPattern() method instead.

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

components

Constructor Summary

Constructors

Constructor and Description
Field26C() Default constructor.
Field26C(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field26C(Tag tag) Creates a new field and initializes its components with content from the parameter tag.

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.
static Tag	emptyTag() Create a Tag with this field name and an empty string as value.
static Field26C	fromJson(java.lang.String json) This method deserializes the JSON data into a Field26C object.
static Field26C	get(SwiftMessage msg) Gets the first instance of Field26C in the given message.
static Field26C	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field26C>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field26C in the given message an empty list is returned if none found.
static java.util.List<Field26C>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field26C from the given block an empty list is returned if none found.
java.lang.String	getAllocation() Gets the Allocation (component 3).
java.lang.String	getComponent1() Gets the component 1 (Delivery Details).
java.lang.String	getComponent2() Gets the component 2 (Delivery Location).
java.lang.String	getComponent3() Gets the component 3 (Allocation).
java.lang.String	getComponent4() Gets the component 4 (Type).
java.lang.String	getComponent5() Gets the component 5 (Denomination).
java.lang.String	getComponent6() Gets the component 6 (Form).
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	getDeliveryDetails() Gets the Delivery Details (component 1).
java.lang.String	getDeliveryLocation() Gets the Delivery Location (component 2).
java.lang.String	getDenomination() Gets the Denomination (component 5).
java.lang.String	getDenominationForm() Deprecated.
java.lang.String	getForm() Gets the Form (component 6).
java.lang.String	getName() Returns the field's name composed by the field number and the letter option (if any).
java.lang.String	getType() Gets the Type (component 4).
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.
static Field26C	newInstance(Field26C source) Copy constructor.
void	parse(java.lang.String value) Parses the parameter value into the internal components structure.
java.lang.String	parserPattern() Returns the field parser pattern.
Field26C	setAllocation(java.lang.String component3) Set the Allocation (component 3).
Field26C	setComponent1(java.lang.String component1) Set the component 1 (Delivery Details).
Field26C	setComponent2(java.lang.String component2) Set the component 2 (Delivery Location).
Field26C	setComponent3(java.lang.String component3) Set the component 3 (Allocation).
Field26C	setComponent4(java.lang.String component4) Set the component 4 (Type).
Field26C	setComponent5(java.lang.String component5) Set the component 5 (Denomination).
Field26C	setComponent6(java.lang.String component6) Set the component 6 (Form).
Field26C	setDeliveryDetails(java.lang.String component1) Set the Delivery Details (component 1).
Field26C	setDeliveryLocation(java.lang.String component2) Set the Delivery Location (component 2).
Field26C	setDenomination(java.lang.String component5) Set the Denomination (component 5).
Field26C	setDenominationForm(java.lang.String denominationForm) Deprecated.
Field26C	setForm(java.lang.String component6) Set the Form (component 6).
Field26C	setType(java.lang.String component4) Set the Type (component 4).
static Tag	tag(java.lang.String value) Create a Tag with this field name and the given value.
java.lang.String	typesPattern() Returns the field component types pattern.
java.lang.String	validatorPattern() Returns the field validator pattern

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

append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, 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

SRU

public static final int SRU

Constant identifying the SRU to which this class belongs to.

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

Constant with the field name 26C.

See Also:

Constant Field Values

F_26C

public static final java.lang.String F_26C

Same as NAME, intended to be clear when using static imports.

See Also:

Constant Field Values

PARSER_PATTERN

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

Deprecated. Use parserPattern() method instead.

See Also:

Constant Field Values

COMPONENTS_PATTERN

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

Deprecated. Use typesPattern() method instead.

See Also:

Constant Field Values

TYPES_PATTERN

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

Deprecated. Use typesPattern() method instead.

See Also:

Constant Field Values

DELIVERY_DETAILS

public static final java.lang.Integer DELIVERY_DETAILS

Component number for the Delivery Details subfield.

DELIVERY_LOCATION

public static final java.lang.Integer DELIVERY_LOCATION

Component number for the Delivery Location subfield.

ALLOCATION

public static final java.lang.Integer ALLOCATION

Component number for the Allocation subfield.

TYPE

public static final java.lang.Integer TYPE

Component number for the Type subfield.

DENOMINATION

public static final java.lang.Integer DENOMINATION

Component number for the Denomination subfield.

FORM

public static final java.lang.Integer FORM

Component number for the Form subfield.

DENOMINATION_FORM

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public static final java.lang.Integer DENOMINATION_FORM

Deprecated.

Component number for the Denomination Form subfield. IMPORTANT: this constant is kept for compatibility, but getting component 5 will now return only part of the value (the Denomination) as the Form is now a separate component.

Constructor Detail

Field26C

public Field26C()

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

Field26C

public Field26C(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

Field26C

public Field26C(Tag tag)

Creates a new field and initializes its components with content from the parameter tag. The value is parsed with parse(String)

Throws:

java.lang.IllegalArgumentException - if the parameter tag is null or its tagname does not match the field name

Since:

7.8

Method Detail

newInstance

public static Field26C newInstance(Field26C source)

Copy constructor. Initializes the components list with a deep copy of the source components list.

Parameters:

source - a field instance to copy

Since:

7.7

tag

public static Tag tag(java.lang.String value)

Create a Tag with this field name and the given value. Shorthand for new Tag(NAME, value)

Since:

7.5

See Also:

NAME

emptyTag

public static Tag emptyTag()

Create a Tag with this field name and an empty string as value. Shorthand for new Tag(NAME, "")

Since:

7.5

See Also:

NAME

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 java.lang.String componentsPattern()

Deprecated. Use typesPattern() instead.

Specified by:

componentsPattern in class Field

typesPattern

public 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

Since:

9.2.7

parserPattern

public java.lang.String parserPattern()

Returns the field parser pattern.

Specified by:

parserPattern in interface PatternContainer

validatorPattern

public java.lang.String validatorPattern()

Returns the field validator pattern

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

getComponent1

public java.lang.String getComponent1()

Gets the component 1 (Delivery Details).

Returns:

the component 1

getDeliveryDetails

public java.lang.String getDeliveryDetails()

Gets the Delivery Details (component 1).

Returns:

the Delivery Details from component 1

getComponent2

public java.lang.String getComponent2()

Gets the component 2 (Delivery Location).

Returns:

the component 2

getDeliveryLocation

public java.lang.String getDeliveryLocation()

Gets the Delivery Location (component 2).

Returns:

the Delivery Location from component 2

getComponent3

public java.lang.String getComponent3()

Gets the component 3 (Allocation).

Returns:

the component 3

getAllocation

public java.lang.String getAllocation()

Gets the Allocation (component 3).

Returns:

the Allocation from component 3

getComponent4

public java.lang.String getComponent4()

Gets the component 4 (Type).

Returns:

the component 4

getType

public java.lang.String getType()

Gets the Type (component 4).

Returns:

the Type from component 4

getComponent5

public java.lang.String getComponent5()

Gets the component 5 (Denomination).

Returns:

the component 5

getDenomination

public java.lang.String getDenomination()

Gets the Denomination (component 5).

Returns:

the Denomination from component 5

getComponent6

public java.lang.String getComponent6()

Gets the component 6 (Form).

Returns:

the component 6

getForm

public java.lang.String getForm()

Gets the Form (component 6).

Returns:

the Form from component 6

setComponent1

public Field26C setComponent1(java.lang.String component1)

Set the component 1 (Delivery Details).

Parameters:

component1 - the Delivery Details to set

Returns:

the field object to enable build pattern

setDeliveryDetails

public Field26C setDeliveryDetails(java.lang.String component1)

Set the Delivery Details (component 1).

Parameters:

component1 - the Delivery Details to set

Returns:

the field object to enable build pattern

setComponent2

public Field26C setComponent2(java.lang.String component2)

Set the component 2 (Delivery Location).

Parameters:

component2 - the Delivery Location to set

Returns:

the field object to enable build pattern

setDeliveryLocation

public Field26C setDeliveryLocation(java.lang.String component2)

Set the Delivery Location (component 2).

Parameters:

component2 - the Delivery Location to set

Returns:

the field object to enable build pattern

setComponent3

public Field26C setComponent3(java.lang.String component3)

Set the component 3 (Allocation).

Parameters:

component3 - the Allocation to set

Returns:

the field object to enable build pattern

setAllocation

public Field26C setAllocation(java.lang.String component3)

Set the Allocation (component 3).

Parameters:

component3 - the Allocation to set

Returns:

the field object to enable build pattern

setComponent4

public Field26C setComponent4(java.lang.String component4)

Set the component 4 (Type).

Parameters:

component4 - the Type to set

Returns:

the field object to enable build pattern

setType

public Field26C setType(java.lang.String component4)

Set the Type (component 4).

Parameters:

component4 - the Type to set

Returns:

the field object to enable build pattern

setComponent5

public Field26C setComponent5(java.lang.String component5)

Set the component 5 (Denomination).

Parameters:

component5 - the Denomination to set

Returns:

the field object to enable build pattern

setDenomination

public Field26C setDenomination(java.lang.String component5)

Set the Denomination (component 5).

Parameters:

component5 - the Denomination to set

Returns:

the field object to enable build pattern

setComponent6

public Field26C setComponent6(java.lang.String component6)

Set the component 6 (Form).

Parameters:

component6 - the Form to set

Returns:

the field object to enable build pattern

setForm

public Field26C setForm(java.lang.String component6)

Set the Form (component 6).

Parameters:

component6 - the Form to set

Returns:

the field object to enable build pattern

getName

public java.lang.String getName()

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

Specified by:

getName in class Field

Returns:

the static value of Field26C.NAME

get

public static Field26C get(SwiftTagListBlock block)

Gets the first occurrence form the tag list or null if not found.

Parameters:

block - may be null or empty

Returns:

null if not found o block is null or empty

get

public static Field26C get(SwiftMessage msg)

Gets the first instance of Field26C in the given message.

Parameters:

msg - may be empty or null

Returns:

null if not found or msg is empty or null

See Also:

get(SwiftTagListBlock)

getAll

public static java.util.List<Field26C> getAll(SwiftMessage msg)

Gets a list of all occurrences of the field Field26C in the given message an empty list is returned if none found.

Parameters:

msg - may be empty or null in which case an empty list is returned

See Also:

getAll(SwiftTagListBlock)

getAll

public static java.util.List<Field26C> getAll(SwiftTagListBlock block)

Gets a list of all occurrences of the field Field26C from the given block an empty list is returned if none found.

Parameters:

block - may be empty or null in which case an empty list is returned

fromJson

public static Field26C fromJson(java.lang.String json)

This method deserializes the JSON data into a Field26C object.

Parameters:

json - JSON structure including tuples with label and value for all field components

Returns:

a new field instance with the JSON data parsed into field components or an empty field id the JSON is invalid

Since:

7.10.3

See Also:

Field.fromJson(String)

getDenominationForm

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

Deprecated.

Gets the Denomination and Form as a unit (components 5 and 6).

Returns:

the Denomination and Form from components 5 and 6

setDenominationForm

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public Field26C setDenominationForm(java.lang.String denominationForm)

Deprecated.

Set the Denomination and Form (components 5 and 6).

Parameters:

denominationForm - the Denomination and Form to set

Returns:

the field object to enable build pattern