com.prowidesoftware.swift.model.field

Class Field137

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field137

All Implemented Interfaces:

JsonSerializable, PatternContainer, java.io.Serializable

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

SWIFT MT Field 137.

Model and parser for field 137 of a SWIFT MT message.

Subfields (components) Data types

1. Component 1: BroadcastIndicator: Character
2. Component 2: UnsequencedBroadcast: String
3. Component 3: BroadcastIssuer: String
4. Component 4: BroadcastNumber: Long

Structure definition

• validation pattern: 1a3!x<CC>4!n
• parser pattern: c3!S<CC>N
• components pattern: cSKN

This class complies with standard release SRU2023

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	BROADCAST_INDICATOR Component number for the Broadcast Indicator subfield.
static java.lang.Integer	BROADCAST_ISSUER Component number for the Broadcast Issuer subfield.
static java.lang.Integer	BROADCAST_NUMBER Component number for the Broadcast Number subfield.
static java.lang.String	COMPONENTS_PATTERN Deprecated. Use typesPattern() method instead.
static java.lang.String	F_137 Same as NAME, intended to be clear when using static imports.
static java.lang.String	NAME Constant with the field name 137.
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.String	TYPES_PATTERN Deprecated. Use typesPattern() method instead.
static java.lang.Integer	UNSEQUENCED_BROADCAST Component number for the Unsequenced Broadcast subfield.

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

components, labelMap

Constructor Summary

Constructors

Constructor and Description
Field137() Default constructor.
Field137(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field137(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 Field137	fromJson(java.lang.String json) This method deserializes the JSON data into a Field137 object.
static Field137	get(SwiftMessage msg) Gets the first instance of Field137 in the given message.
static Field137	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field137>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field137 in the given message an empty list is returned if none found.
static java.util.List<Field137>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field137 from the given block an empty list is returned if none found.
java.lang.String	getBroadcastIndicator() Gets the Broadcast Indicator (component 1).
java.lang.String	getBroadcastIssuer() Gets the Broadcast Issuer (component 3).
java.lang.String	getBroadcastNumber() Gets the Broadcast Number (component 4).
java.lang.Long	getBroadcastNumberAsLong() Get the Broadcast Number (component 4) as Long
java.lang.Number	getBroadcastNumberAsNumber() Deprecated. use #getBroadcastNumberAsLong() instead
java.lang.String	getComponent1() Gets the component 1 (Broadcast Indicator).
java.lang.String	getComponent2() Gets the component 2 (Unsequenced Broadcast).
java.lang.String	getComponent3() Gets the component 3 (Broadcast Issuer).
java.lang.String	getComponent4() Gets the component 4 (Broadcast Number).
java.lang.Long	getComponent4AsLong() Get the component 4 as Long
java.lang.Number	getComponent4AsNumber() Deprecated. use #getComponent4AsLong() instead
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.
java.lang.String	getName() Returns the field's name composed by the field number and the letter option (if any).
java.lang.String	getUnsequencedBroadcast() Gets the Unsequenced Broadcast (component 2).
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 Field137	newInstance(Field137 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.
Field137	setBroadcastIndicator(java.lang.String component1) Set the Broadcast Indicator (component 1).
Field137	setBroadcastIssuer(java.lang.String component3) Set the Broadcast Issuer (component 3).
Field137	setBroadcastNumber(java.lang.Long component4) Set the Broadcast Number (component 4) from a Long object.
Field137	setBroadcastNumber(java.lang.Number component4) Alternative method setter for field's Broadcast Number (component 4) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field137	setBroadcastNumber(java.lang.String component4) Set the Broadcast Number (component 4).
Field137	setComponent1(java.lang.String component1) Set the component 1 (Broadcast Indicator).
Field137	setComponent2(java.lang.String component2) Set the component 2 (Unsequenced Broadcast).
Field137	setComponent3(java.lang.String component3) Set the component 3 (Broadcast Issuer).
Field137	setComponent4(java.lang.Long component4) Set the component4 from a Long object.
Field137	setComponent4(java.lang.Number component4) Alternative method setter for field's Broadcast Number (component 4) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
Field137	setComponent4(java.lang.String component4) Set the component 4 (Broadcast Number).
Field137	setUnsequencedBroadcast(java.lang.String component2) Set the Unsequenced Broadcast (component 2).
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, componentNameToNumber, equals, findComponentStartingWith, format, formatAccount, formatNumber, 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

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

See Also:

Constant Field Values

F_137

public static final java.lang.String F_137

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

See Also:

Constant Field Values

PARSER_PATTERN

@Deprecated
 @ProwideDeprecated(phase4=SRU2024)
public static final java.lang.String PARSER_PATTERN

Deprecated. Use parserPattern() method instead.

See Also:

Constant Field Values

COMPONENTS_PATTERN

@Deprecated
 @ProwideDeprecated(phase4=SRU2024)
public static final java.lang.String COMPONENTS_PATTERN

Deprecated. Use typesPattern() method instead.

See Also:

Constant Field Values

TYPES_PATTERN

@Deprecated
 @ProwideDeprecated(phase4=SRU2024)
public static final java.lang.String TYPES_PATTERN

Deprecated. Use typesPattern() method instead.

See Also:

Constant Field Values

BROADCAST_INDICATOR

public static final java.lang.Integer BROADCAST_INDICATOR

Component number for the Broadcast Indicator subfield.

UNSEQUENCED_BROADCAST

public static final java.lang.Integer UNSEQUENCED_BROADCAST

Component number for the Unsequenced Broadcast subfield.

BROADCAST_ISSUER

public static final java.lang.Integer BROADCAST_ISSUER

Component number for the Broadcast Issuer subfield.

BROADCAST_NUMBER

public static final java.lang.Integer BROADCAST_NUMBER

Component number for the Broadcast Number subfield.

Constructor Detail

Field137

public Field137()

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

Field137

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

Field137

public Field137(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 Field137 newInstance(Field137 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(phase4=SRU2024)
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

getLabelMap

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

Description copied from class: Field

Returns a mapping between component labels and the internal component number. Component labels are in lowercase and without spaces and separators. If a for a given component there is more than one label option, both are mapped to the same component number.

Specified by:

getLabelMap in class Field

Since:

9.3.12

See Also:

Field.getLabelMap()

getComponent1

public java.lang.String getComponent1()

Gets the component 1 (Broadcast Indicator).

Returns:

the component 1

getBroadcastIndicator

public java.lang.String getBroadcastIndicator()

Gets the Broadcast Indicator (component 1).

Returns:

the Broadcast Indicator from component 1

getComponent2

public java.lang.String getComponent2()

Gets the component 2 (Unsequenced Broadcast).

Returns:

the component 2

getUnsequencedBroadcast

public java.lang.String getUnsequencedBroadcast()

Gets the Unsequenced Broadcast (component 2).

Returns:

the Unsequenced Broadcast from component 2

getComponent3

public java.lang.String getComponent3()

Gets the component 3 (Broadcast Issuer).

Returns:

the component 3

getBroadcastIssuer

public java.lang.String getBroadcastIssuer()

Gets the Broadcast Issuer (component 3).

Returns:

the Broadcast Issuer from component 3

getComponent4

public java.lang.String getComponent4()

Gets the component 4 (Broadcast Number).

Returns:

the component 4

getComponent4AsLong

public java.lang.Long getComponent4AsLong()

Get the component 4 as Long

Returns:

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

Since:

9.2.7

getComponent4AsNumber

@Deprecated
 @ProwideDeprecated(phase4=SRU2024)
public java.lang.Number getComponent4AsNumber()

Deprecated. use #getComponent4AsLong() instead

getBroadcastNumber

public java.lang.String getBroadcastNumber()

Gets the Broadcast Number (component 4).

Returns:

the Broadcast Number from component 4

getBroadcastNumberAsLong

public java.lang.Long getBroadcastNumberAsLong()

Get the Broadcast Number (component 4) as Long

Returns:

the Broadcast Number from component 4 converted to Long or null if cannot be converted

Since:

9.2.7

getBroadcastNumberAsNumber

@Deprecated
 @ProwideDeprecated(phase4=SRU2024)
public java.lang.Number getBroadcastNumberAsNumber()

Deprecated. use #getBroadcastNumberAsLong() instead

setComponent1

public Field137 setComponent1(java.lang.String component1)

Set the component 1 (Broadcast Indicator).

Parameters:

component1 - the Broadcast Indicator to set

Returns:

the field object to enable build pattern

setBroadcastIndicator

public Field137 setBroadcastIndicator(java.lang.String component1)

Set the Broadcast Indicator (component 1).

Parameters:

component1 - the Broadcast Indicator to set

Returns:

the field object to enable build pattern

setComponent2

public Field137 setComponent2(java.lang.String component2)

Set the component 2 (Unsequenced Broadcast).

Parameters:

component2 - the Unsequenced Broadcast to set

Returns:

the field object to enable build pattern

setUnsequencedBroadcast

public Field137 setUnsequencedBroadcast(java.lang.String component2)

Set the Unsequenced Broadcast (component 2).

Parameters:

component2 - the Unsequenced Broadcast to set

Returns:

the field object to enable build pattern

setComponent3

public Field137 setComponent3(java.lang.String component3)

Set the component 3 (Broadcast Issuer).

Parameters:

component3 - the Broadcast Issuer to set

Returns:

the field object to enable build pattern

setBroadcastIssuer

public Field137 setBroadcastIssuer(java.lang.String component3)

Set the Broadcast Issuer (component 3).

Parameters:

component3 - the Broadcast Issuer to set

Returns:

the field object to enable build pattern

setComponent4

public Field137 setComponent4(java.lang.String component4)

Set the component 4 (Broadcast Number).

Parameters:

component4 - the Broadcast Number to set

Returns:

the field object to enable build pattern

setComponent4

public Field137 setComponent4(java.lang.Long component4)

Set the component4 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 setComponent4(String) method.

Parameters:

component4 - the Long with the Broadcast Number content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent4(String)

setComponent4

public Field137 setComponent4(java.lang.Number component4)

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

Parameters:

component4 - the Number with the Broadcast Number content to set

Returns:

the field object to enable build pattern

See Also:

setBroadcastNumber(java.lang.Long)

setBroadcastNumber

public Field137 setBroadcastNumber(java.lang.String component4)

Set the Broadcast Number (component 4).

Parameters:

component4 - the Broadcast Number to set

Returns:

the field object to enable build pattern

setBroadcastNumber

public Field137 setBroadcastNumber(java.lang.Long component4)

Set the Broadcast Number (component 4) from a Long object.

Parameters:

component4 - Long with the Broadcast Number content to set

Returns:

the field object to enable build pattern

Since:

9.2.7

See Also:

setComponent4(java.lang.Long)

setBroadcastNumber

public Field137 setBroadcastNumber(java.lang.Number component4)

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

Parameters:

component4 - the Number with the Broadcast Number content to set

Returns:

the field object to enable build pattern

See Also:

setBroadcastNumber(java.lang.Long)

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

get

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

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

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

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

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