com.prowidesoftware.swift.model.field

Class Field20

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field20

All Implemented Interfaces:

PatternContainer, Serializable

public class Field20
extends Field
implements Serializable

Field 20

validation pattern: 16x(***)
parser pattern: S
components pattern: S

Components Data types

• component1: String

NOTE: this source code has been generated from template

Author:

www.prowidesoftware.com

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENTS_PATTERN
static String	F_20 same as NAME, intended to be clear when using static imports
static String	NAME Constant with the field name 20
static String	PARSER_PATTERN

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

components

Constructor Summary

Constructors

Constructor and Description
Field20() Default constructor
Field20(String value) Creates the field parsing the parameter value into fields' components

Method Summary

Methods

Modifier and Type	Method and Description
String	componentsPattern()
static Tag	emptyTag() Create a Tag with this field name and an empty string as value Shorthand for new Tag(NAME, "")
static Field20	get(SwiftMessage msg) Get the first instance of Field20 in the given message.
static Field20	get(SwiftTagListBlock block) Get the first occurrence form the tag list or null if not found.
static List<Field20>	getAll(SwiftMessage msg) Get a list of all occurrences of the field Field20 in the given message an empty list is returned if none found.
static List<Field20>	getAll(SwiftTagListBlock block) Get a list of all occurrences of the field Field20 from the given block an empty list is returned if none found.
String	getComponent1() Get the component1
String	getComponent1AsString() Deprecated.
String	getReference() Get the Reference (component1).
String	getValue() Serializes the fields' components into the single string value (SWIFT format)
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.
String	parserPattern()
Field20	setComponent1(String component1) Set the component1.
Field20	setReference(String component1) Set the Reference (component1).
static Tag	tag(String value) Create a Tag with this field name and the given value.

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

appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponents, getConditionalQualifier, getDSS, getField, getLabel, getLabel, getLabel, getLabel, getName, getValueByCodeword, getValueDisplay, hashCode, is, is, is, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toString

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENTS_PATTERN

public static final String COMPONENTS_PATTERN

See Also:

Constant Field Values

F_20

public static final String F_20

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

See Also:

Constant Field Values

NAME

public static final String NAME

Constant with the field name 20

See Also:

Constant Field Values

PARSER_PATTERN

public static final String PARSER_PATTERN

See Also:

Constant Field Values

Constructor Detail

Field20

public Field20()

Default constructor

Field20

public Field20(String value)

Creates the field parsing the parameter value into fields' components

Parameters:

value -

Method Detail

componentsPattern

public String componentsPattern()

Specified by:

componentsPattern in interface PatternContainer

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

get

public static Field20 get(SwiftMessage msg)

Get the first instance of Field20 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)

get

public static Field20 get(SwiftTagListBlock block)

Get 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

getAll

public static List<Field20> getAll(SwiftMessage msg)

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

Get a list of all occurrences of the field Field20 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

getComponent1

public String getComponent1()

Get the component1

Returns:

the component1

getComponent1AsString

@Deprecated
public String getComponent1AsString()

Deprecated.

Same as getComponent(1)

getReference

public String getReference()

Get the Reference (component1).

Returns:

the Reference from component1

getValue

public String getValue()

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

Overrides:

getValue in class Field

Returns:

SWIFT formatted value

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

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

parserPattern

public String parserPattern()

Specified by:

parserPattern in interface PatternContainer

setComponent1

public Field20 setComponent1(String component1)

Set the component1.

Parameters:

component1 - the component1 to set

setReference

public Field20 setReference(String component1)

Set the Reference (component1).

Parameters:

component1 - the Reference to set

tag

public static Tag tag(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