com.prowidesoftware.swift.model.field

Class Field35B

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field35B

All Implemented Interfaces:

JsonSerializable, MultiLineField, PatternContainer, java.io.Serializable

@Generated
public class Field35B
extends Field
implements java.io.Serializable, MultiLineField

SWIFT MT Field 35B

Model and parser for field 35B 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: [<ISIN> 12!c][$][35x][$35x]0-3(****)
• parser pattern: [<ISIN><SPACE>S][$S]0-4
• components pattern: SSSSSS

This class complies with standard release SRU2020

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENTS_PATTERN
static java.lang.Integer	DESCRIPTION Component number for the Description subfield
static java.lang.String	F_35B same as NAME, intended to be clear when using static imports
static java.lang.Integer	ISIN Component number for the ISIN subfield
static java.lang.String	NAME Constant with the field name 35B
static java.lang.String	PARSER_PATTERN
static java.lang.Integer	QUALIFIER Component number for the Qualifier subfield
static int	SRU Constant identifying the SRU to which this class belongs to.

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

components

Constructor Summary

Constructors

Constructor and Description
Field35B() Default constructor.
Field35B(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field35B(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() 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.
static Tag	emptyTag() Create a Tag with this field name and an empty string as value Shorthand for new Tag(NAME, "")
static Field35B	fromJson(java.lang.String json) This method deserializes the JSON data into a Field35B object.
static Field35B	get(SwiftMessage msg) Gets the first instance of Field35B in the given message.
static Field35B	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field35B>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field35B in the given message an empty list is returned if none found.
static java.util.List<Field35B>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field35B from the given block an empty list is returned if none found.
java.lang.String	getComponent1() Gets the component 1 (Qualifier).
java.lang.String	getComponent2() Gets the component 2 (ISIN).
java.lang.String	getComponent3() Gets the component 3 (Description).
java.lang.String	getComponent4() Gets the component 4 (Description).
java.lang.String	getComponent5() Gets the component 5 (Description).
java.lang.String	getComponent6() Gets the component 6 (Description).
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	getDescription() Gets the Description as a concatenation of component 3 to component 6.
java.lang.String	getDescription(java.lang.CharSequence deli) Gets the Description as a concatenation of component 3 to component 6 joined together with a copy of the specified delimiter.
java.lang.String	getDescriptionLine1() Gets the Description (component 3).
java.lang.String	getDescriptionLine2() Gets the Description (component 4).
java.lang.String	getDescriptionLine3() Gets the Description (component 5).
java.lang.String	getDescriptionLine4() Gets the Description (component 6).
java.lang.String	getISIN() Gets the ISIN (component 2).
java.lang.String	getLine(int line) Returns a specific line from the field's value.
java.lang.String	getLine(int line, int offset) Returns a specific line from the field's value.
java.util.List<java.lang.String>	getLines() Returns the field value split into lines.
java.util.List<java.lang.String>	getLines(int offset) Returns the field value starting at the offset component, split into lines.
java.util.List<java.lang.String>	getLinesBetween(int start, int end) Returns a specific subset of lines from the field's value, given a range.
java.util.List<java.lang.String>	getLinesBetween(int start, int end, int offset) Returns a specific subset of lines from the field's value, starting at the offset component.
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 (component 1).
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 Field35B	newInstance(Field35B source) Copy constructor. Initializes the components list with a deep copy of the source components list.
void	parse(java.lang.String value) Parses the parameter value into the internal components structure.
java.lang.String	parserPattern() Returns the field parser pattern
Field35B	setComponent1(java.lang.String component1) Set the component1 (Qualifier).
Field35B	setComponent2(java.lang.String component2) Set the component2 (ISIN).
Field35B	setComponent3(java.lang.String component3) Set the component3 (Description).
Field35B	setComponent4(java.lang.String component4) Set the component4 (Description).
Field35B	setComponent5(java.lang.String component5) Set the component5 (Description).
Field35B	setComponent6(java.lang.String component6) Set the component6 (Description).
Field35B	setDescription(java.lang.String value) Set the Description splitting the parameter lines into components 3 to 6.
Field35B	setDescriptionLine1(java.lang.String component3) Set the Description (component3).
Field35B	setDescriptionLine2(java.lang.String component4) Set the Description (component4).
Field35B	setDescriptionLine3(java.lang.String component5) Set the Description (component5).
Field35B	setDescriptionLine4(java.lang.String component6) Set the Description (component6).
Field35B	setISIN(java.lang.String component2) Set the ISIN (component2).
Field35B	setQualifier(java.lang.String component1) Set the Qualifier (component1).
static Tag	tag(java.lang.String value) Create a Tag with this field name and the given value.
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, 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

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

See Also:

Constant Field Values

F_35B

public static final java.lang.String F_35B

same as NAME, intended to be clear when using static imports

See Also:

Constant Field Values

PARSER_PATTERN

public static final java.lang.String PARSER_PATTERN

See Also:

Constant Field Values

COMPONENTS_PATTERN

public static final java.lang.String COMPONENTS_PATTERN

See Also:

Constant Field Values

QUALIFIER

public static final java.lang.Integer QUALIFIER

Component number for the Qualifier subfield

ISIN

public static final java.lang.Integer ISIN

Component number for the ISIN subfield

DESCRIPTION

public static final java.lang.Integer DESCRIPTION

Component number for the Description subfield

Constructor Detail

Field35B

public Field35B()

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

Field35B

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

Field35B

public Field35B(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 Field35B newInstance(Field35B 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

public final java.lang.String componentsPattern()

Returns the field components pattern

Specified by:

componentsPattern in interface PatternContainer

Specified by:

componentsPattern in class Field

Returns:

the static value of Field35B.COMPONENTS_PATTERN

parserPattern

public final java.lang.String parserPattern()

Returns the field parser pattern

Specified by:

parserPattern in interface PatternContainer

Returns:

the static value of Field35B.PARSER_PATTERN

validatorPattern

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

protected 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 (Qualifier).

Returns:

the component 1

getQualifier

public java.lang.String getQualifier()

Gets the Qualifier (component 1).

Returns:

the Qualifier from component 1

getComponent2

public java.lang.String getComponent2()

Gets the component 2 (ISIN).

Returns:

the component 2

getISIN

public java.lang.String getISIN()

Gets the ISIN (component 2).

Returns:

the ISIN from component 2

getComponent3

public java.lang.String getComponent3()

Gets the component 3 (Description).

Returns:

the component 3

getDescriptionLine1

public java.lang.String getDescriptionLine1()

Gets the Description (component 3).

Returns:

the Description from component 3

getDescriptionLine2

public java.lang.String getDescriptionLine2()

Gets the Description (component 4).

Returns:

the Description from component 4

getDescriptionLine3

public java.lang.String getDescriptionLine3()

Gets the Description (component 5).

Returns:

the Description from component 5

getDescriptionLine4

public java.lang.String getDescriptionLine4()

Gets the Description (component 6).

Returns:

the Description from component 6

getDescription

public java.lang.String getDescription()

Gets the Description as a concatenation of component 3 to component 6.

Returns:

the Description from components

getDescription

public java.lang.String getDescription(java.lang.CharSequence deli)

Gets the Description as a concatenation of component 3 to component 6 joined together with a copy of the specified delimiter.

Parameters:

deli - the delimiter that separates each component

Returns:

the Description from components

Since:

9.1.4

getComponent4

public java.lang.String getComponent4()

Gets the component 4 (Description).

Returns:

the component 4

getComponent5

public java.lang.String getComponent5()

Gets the component 5 (Description).

Returns:

the component 5

getComponent6

public java.lang.String getComponent6()

Gets the component 6 (Description).

Returns:

the component 6

setComponent1

public Field35B setComponent1(java.lang.String component1)

Set the component1 (Qualifier).

Parameters:

component1 - the component1 to set

setQualifier

public Field35B setQualifier(java.lang.String component1)

Set the Qualifier (component1).

Parameters:

component1 - the Qualifier to set

setComponent2

public Field35B setComponent2(java.lang.String component2)

Set the component2 (ISIN).

Parameters:

component2 - the component2 to set

setISIN

public Field35B setISIN(java.lang.String component2)

Set the ISIN (component2).

Parameters:

component2 - the ISIN to set

setComponent3

public Field35B setComponent3(java.lang.String component3)

Set the component3 (Description).

Parameters:

component3 - the component3 to set

setDescriptionLine1

public Field35B setDescriptionLine1(java.lang.String component3)

Set the Description (component3).

Parameters:

component3 - the Description to set

setDescriptionLine2

public Field35B setDescriptionLine2(java.lang.String component4)

Set the Description (component4).

Parameters:

component4 - the Description to set

setDescriptionLine3

public Field35B setDescriptionLine3(java.lang.String component5)

Set the Description (component5).

Parameters:

component5 - the Description to set

setDescriptionLine4

public Field35B setDescriptionLine4(java.lang.String component6)

Set the Description (component6).

Parameters:

component6 - the Description to set

setDescription

public Field35B setDescription(java.lang.String value)

Set the Description splitting the parameter lines into components 3 to 6.

Parameters:

value - the Description to set, may contain line ends and each line will be set to its correspondent component attribute

setComponent4

public Field35B setComponent4(java.lang.String component4)

Set the component4 (Description).

Parameters:

component4 - the component4 to set

setComponent5

public Field35B setComponent5(java.lang.String component5)

Set the component5 (Description).

Parameters:

component5 - the component5 to set

setComponent6

public Field35B setComponent6(java.lang.String component6)

Set the component6 (Description).

Parameters:

component6 - the component6 to set

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 Field35B.NAME

get

public static Field35B 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 Field35B get(SwiftMessage msg)

Gets the first instance of Field35B 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<Field35B> getAll(SwiftMessage msg)

Gets a list of all occurrences of the field Field35B 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<Field35B> getAll(SwiftTagListBlock block)

Gets a list of all occurrences of the field Field35B 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

getLine

public java.lang.String getLine(int line)

Returns a specific line from the field's value.

Specified by:

getLine in interface MultiLineField

Parameters:

line - a reference to a specific line in the field, first line being 1

Returns:

line content or null if not present or if line number is above the expected

Since:

7.7

See Also:

MultiLineField.getLine(int)

getLine

public java.lang.String getLine(int line,
                                int offset)

Returns a specific line from the field's value.

Specified by:

getLine in interface MultiLineField

Parameters:

line - a reference to a specific line in the field, first line being 1

offset - an optional component number used as offset when counting lines

Returns:

line content or null if not present or if line number is above the expected

Since:

7.7

See Also:

MultiLineField.getLine(int, int)

getLines

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

Returns the field value split into lines.

Specified by:

getLines in interface MultiLineField

Returns:

lines content or empty list if field's value is empty

Since:

7.7

See Also:

MultiLineField.getLines()

getLines

public java.util.List<java.lang.String> getLines(int offset)

Returns the field value starting at the offset component, split into lines.

Specified by:

getLines in interface MultiLineField

Parameters:

offset - an optional component number used as offset when counting lines

Returns:

found lines or empty list if lines are not present or the offset is invalid

Since:

7.7

See Also:

MultiLineField.getLines(int)

getLinesBetween

public java.util.List<java.lang.String> getLinesBetween(int start,
                                                        int end)

Returns a specific subset of lines from the field's value, given a range.

Specified by:

getLinesBetween in interface MultiLineField

Parameters:

start - a reference to a specific line in the field, first line being 1

end - a reference to a specific line in the field, must be greater than start

Returns:

found lines or empty list if value is empty

Since:

7.7

See Also:

MultiLineField.getLinesBetween(int, int )

getLinesBetween

public java.util.List<java.lang.String> getLinesBetween(int start,
                                                        int end,
                                                        int offset)

Returns a specific subset of lines from the field's value, starting at the offset component.

Specified by:

getLinesBetween in interface MultiLineField

Parameters:

start - a reference to a specific line in the field, first line being 1

end - a reference to a specific line in the field, must be greater than start

offset - an optional component number used as offset when counting lines

Returns:

found lines or empty list if lines are not present or the offset is invalid

Since:

7.7

See Also:

MultiLineField.getLinesBetween(int start, int end, int offset)

fromJson

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

This method deserializes the JSON data into a Field35B 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)