com.prowidesoftware.swift.model.field

Class Field38G

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field38G

All Implemented Interfaces:

JsonSerializable, PatternContainer, java.io.Serializable

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

SWIFT MT Field 38G.

Model and parser for field 38G of a SWIFT MT message.

Subfields (components) Data types

1. Long
2. String
3. Long
4. String

Structure definition

• validation pattern: 2n1a/2n1a
• parser pattern: NS/NS
• components pattern: NSNS

This class complies with standard release SRU2022

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENTS_PATTERN Deprecated. Use typesPattern() method instead.
static java.lang.String	F_38G Same as NAME, intended to be clear when using static imports.
static java.lang.String	NAME Constant with the field name 38G.
static java.lang.Integer	NUMBER_FROM Component number for the Number From subfield.
static java.lang.Integer	NUMBER_TO Component number for the Number To subfield.
static java.lang.String	PARSER_PATTERN Deprecated. Use parserPattern() method instead.
static java.lang.Integer	PERIOD_FROM Component number for the Period From subfield.
static java.lang.Integer	PERIOD_TO Component number for the Period To subfield.
static int	SRU Constant identifying the SRU to which this class belongs to.
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
Field38G() Default constructor.
Field38G(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field38G(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 Field38G	fromJson(java.lang.String json) This method deserializes the JSON data into a Field38G object.
static Field38G	get(SwiftMessage msg) Gets the first instance of Field38G in the given message.
static Field38G	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field38G>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field38G in the given message an empty list is returned if none found.
static java.util.List<Field38G>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field38G from the given block an empty list is returned if none found.
java.lang.String	getComponent1() Gets the component 1 (Number From).
java.lang.Long	getComponent1AsLong() Get the component 1 as Long
java.lang.Number	getComponent1AsNumber() Deprecated.
java.lang.String	getComponent2() Gets the component 2 (Period From).
java.lang.String	getComponent3() Gets the component 3 (Number To).
java.lang.Long	getComponent3AsLong() Get the component 3 as Long
java.lang.Number	getComponent3AsNumber() Deprecated.
java.lang.String	getComponent4() Gets the component 4 (Period To).
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	getName() Returns the field's name composed by the field number and the letter option (if any).
java.lang.String	getNumberFrom() Gets the Number From (component 1).
java.lang.Long	getNumberFromAsLong() Get the Number From (component 1) as Long
java.lang.Number	getNumberFromAsNumber() Deprecated.
java.lang.String	getNumberTo() Gets the Number To (component 3).
java.lang.Long	getNumberToAsLong() Get the Number To (component 3) as Long
java.lang.Number	getNumberToAsNumber() Deprecated.
java.lang.String	getPeriodFrom() Gets the Period From (component 2).
java.lang.String	getPeriodTo() Gets the Period To (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 Field38G	newInstance(Field38G 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.
Field38G	setComponent1(java.lang.Long component1) Set the component1 from a Long object.
Field38G	setComponent1(java.lang.Number component1) Alternative method setter for field's Number From (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field38G	setComponent1(java.lang.String component1) Set the component 1 (Number From).
Field38G	setComponent2(java.lang.String component2) Set the component 2 (Period From).
Field38G	setComponent3(java.lang.Long component3) Set the component3 from a Long object.
Field38G	setComponent3(java.lang.Number component3) Alternative method setter for field's Number To (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field38G	setComponent3(java.lang.String component3) Set the component 3 (Number To).
Field38G	setComponent4(java.lang.String component4) Set the component 4 (Period To).
Field38G	setNumberFrom(java.lang.Long component1) Set the Number From (component 1) from a Long object.
Field38G	setNumberFrom(java.lang.Number component1) Alternative method setter for field's Number From (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field38G	setNumberFrom(java.lang.String component1) Set the Number From (component 1).
Field38G	setNumberTo(java.lang.Long component3) Set the Number To (component 3) from a Long object.
Field38G	setNumberTo(java.lang.Number component3) Alternative method setter for field's Number To (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field38G	setNumberTo(java.lang.String component3) Set the Number To (component 3).
Field38G	setPeriodFrom(java.lang.String component2) Set the Period From (component 2).
Field38G	setPeriodTo(java.lang.String component4) Set the Period To (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 38G.

See Also:

Constant Field Values

F_38G

public static final java.lang.String F_38G

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

NUMBER_FROM

public static final java.lang.Integer NUMBER_FROM

Component number for the Number From subfield.

PERIOD_FROM

public static final java.lang.Integer PERIOD_FROM

Component number for the Period From subfield.

NUMBER_TO

public static final java.lang.Integer NUMBER_TO

Component number for the Number To subfield.

PERIOD_TO

public static final java.lang.Integer PERIOD_TO

Component number for the Period To subfield.

Constructor Detail

Field38G

public Field38G()

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

Field38G

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

Field38G

public Field38G(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 Field38G newInstance(Field38G 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 (Number From).

Returns:

the component 1

getComponent1AsLong

public java.lang.Long getComponent1AsLong()

Get the component 1 as Long

Returns:

the component 1 converted to Long or null if cannot be converted

Since:

9.2.7

getComponent1AsNumber

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getComponent1AsNumber()

Deprecated.

Get the component 1 as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent1AsLong() to get the proper value.

Returns:

the component 1 converted to Number (BigDecimal) or null if cannot be converted

See Also:

getComponent1AsLong()

getNumberFrom

public java.lang.String getNumberFrom()

Gets the Number From (component 1).

Returns:

the Number From from component 1

getNumberFromAsLong

public java.lang.Long getNumberFromAsLong()

Get the Number From (component 1) as Long

Returns:

the Number From from component 1 converted to Long or null if cannot be converted

Since:

9.2.7

getNumberFromAsNumber

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getNumberFromAsNumber()

Deprecated.

Get the Number From (component 1) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent1AsLong() to get the proper value.

Returns:

the component 1 converted to Number (BigDecimal) or null if cannot be converted

See Also:

getNumberFromAsLong()

getComponent2

public java.lang.String getComponent2()

Gets the component 2 (Period From).

Returns:

the component 2

getPeriodFrom

public java.lang.String getPeriodFrom()

Gets the Period From (component 2).

Returns:

the Period From from component 2

getComponent3

public java.lang.String getComponent3()

Gets the component 3 (Number To).

Returns:

the component 3

getComponent3AsLong

public java.lang.Long getComponent3AsLong()

Get the component 3 as Long

Returns:

the component 3 converted to Long or null if cannot be converted

Since:

9.2.7

getComponent3AsNumber

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getComponent3AsNumber()

Deprecated.

Get the component 3 as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent3AsLong() to get the proper value.

Returns:

the component 3 converted to Number (BigDecimal) or null if cannot be converted

See Also:

getComponent3AsLong()

getNumberTo

public java.lang.String getNumberTo()

Gets the Number To (component 3).

Returns:

the Number To from component 3

getNumberToAsLong

public java.lang.Long getNumberToAsLong()

Get the Number To (component 3) as Long

Returns:

the Number To from component 3 converted to Long or null if cannot be converted

Since:

9.2.7

getNumberToAsNumber

@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getNumberToAsNumber()

Deprecated.

Get the Number To (component 3) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent3AsLong() to get the proper value.

Returns:

the component 3 converted to Number (BigDecimal) or null if cannot be converted

See Also:

getNumberToAsLong()

getComponent4

public java.lang.String getComponent4()

Gets the component 4 (Period To).

Returns:

the component 4

getPeriodTo

public java.lang.String getPeriodTo()

Gets the Period To (component 4).

Returns:

the Period To from component 4

setComponent1

public Field38G setComponent1(java.lang.String component1)

Set the component 1 (Number From).

Parameters:

component1 - the Number From to set

Returns:

the field object to enable build pattern

setComponent1

public Field38G setComponent1(java.lang.Long component1)

Set the component1 from a Long object.
If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent1(String) method.

Parameters:

component1 - the Long with the Number From content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent1(String)

setComponent1

public Field38G setComponent1(java.lang.Number component1)

Alternative method setter for field's Number From (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

Parameters:

component1 - the Number with the Number From content to set

Returns:

the field object to enable build pattern

See Also:

setNumberFrom(java.lang.Long)

setNumberFrom

public Field38G setNumberFrom(java.lang.String component1)

Set the Number From (component 1).

Parameters:

component1 - the Number From to set

Returns:

the field object to enable build pattern

setNumberFrom

public Field38G setNumberFrom(java.lang.Long component1)

Set the Number From (component 1) from a Long object.

Parameters:

component1 - Long with the Number From content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent1(java.lang.Long)

setNumberFrom

public Field38G setNumberFrom(java.lang.Number component1)

Alternative method setter for field's Number From (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

Parameters:

component1 - the Number with the Number From content to set

Returns:

the field object to enable build pattern

See Also:

setNumberFrom(java.lang.Long)

setComponent2

public Field38G setComponent2(java.lang.String component2)

Set the component 2 (Period From).

Parameters:

component2 - the Period From to set

Returns:

the field object to enable build pattern

setPeriodFrom

public Field38G setPeriodFrom(java.lang.String component2)

Set the Period From (component 2).

Parameters:

component2 - the Period From to set

Returns:

the field object to enable build pattern

setComponent3

public Field38G setComponent3(java.lang.String component3)

Set the component 3 (Number To).

Parameters:

component3 - the Number To to set

Returns:

the field object to enable build pattern

setComponent3

public Field38G setComponent3(java.lang.Long component3)

Set the component3 from a Long object.
If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent3(String) method.

Parameters:

component3 - the Long with the Number To content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent3(String)

setComponent3

public Field38G setComponent3(java.lang.Number component3)

Alternative method setter for field's Number To (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

Parameters:

component3 - the Number with the Number To content to set

Returns:

the field object to enable build pattern

See Also:

setNumberTo(java.lang.Long)

setNumberTo

public Field38G setNumberTo(java.lang.String component3)

Set the Number To (component 3).

Parameters:

component3 - the Number To to set

Returns:

the field object to enable build pattern

setNumberTo

public Field38G setNumberTo(java.lang.Long component3)

Set the Number To (component 3) from a Long object.

Parameters:

component3 - Long with the Number To content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent3(java.lang.Long)

setNumberTo

public Field38G setNumberTo(java.lang.Number component3)

Alternative method setter for field's Number To (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

Parameters:

component3 - the Number with the Number To content to set

Returns:

the field object to enable build pattern

See Also:

setNumberTo(java.lang.Long)

setComponent4

public Field38G setComponent4(java.lang.String component4)

Set the component 4 (Period To).

Parameters:

component4 - the Period To to set

Returns:

the field object to enable build pattern

setPeriodTo

public Field38G setPeriodTo(java.lang.String component4)

Set the Period To (component 4).

Parameters:

component4 - the Period To 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 Field38G.NAME

get

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

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

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

Gets a list of all occurrences of the field Field38G 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 Field38G fromJson(java.lang.String json)

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