com.prowidesoftware.swift.model.field

Class Field77J

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.Field77J

All Implemented Interfaces:

MultiLineField, PatternContainer, Serializable

public class Field77J
extends Field
implements Serializable, MultiLineField

Field 77J

validation pattern: CUSTOM
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_77J same as NAME, intended to be clear when using static imports
static String	NAME Constant with the field name 77J
static String	PARSER_PATTERN

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

components

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	componentsPattern()
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 Field77J	get(SwiftMessage msg) Get the first instance of Field77J in the given message.
static Field77J	get(SwiftTagListBlock block) Get the first occurrence form the tag list or null if not found.
static List<Field77J>	getAll(SwiftMessage msg) Get a list of all occurrences of the field Field77J in the given message an empty list is returned if none found.
static List<Field77J>	getAll(SwiftTagListBlock block) Get a list of all occurrences of the field Field77J from the given block an empty list is returned if none found.
String	getComponent1() Get the component1
String	getComponent1AsString() Deprecated.
String	getLine(int line) Returns a specific line from the field's value.
String	getLine(int line, int offset) Returns a specific line from the field's value.
List<String>	getLines() Returns the field value split into lines.
List<String>	getLines(int offset) Returns the field value starting at the offset component, split into lines.
List<String>	getLinesBetween(int start, int end) Returns a specific subset of lines from the field's value, given a range.
List<String>	getLinesBetween(int start, int end, int offset) Returns a specific subset of lines from the field's value, starting at the offset component.
String	getName() Deprecated. use constant Field77J
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.
static Field77J	newInstance(Field77J source) Copy constructor. Initializes the components list with a deep copy of the source components list.
String	parserPattern()
Field77J	setComponent1(String component1) Set the 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, getLine, getValueByCodeword, getValueDisplay, hashCode, is, is, is, isAnyOf, 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

NAME

public static final String NAME

Constant with the field name 77J

See Also:

Constant Field Values

F_77J

public static final String F_77J

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

See Also:

Constant Field Values

PARSER_PATTERN

public static final String PARSER_PATTERN

See Also:

Constant Field Values

COMPONENTS_PATTERN

public static final String COMPONENTS_PATTERN

See Also:

Constant Field Values

Constructor Detail

Field77J

public Field77J()

Default constructor

Field77J

public Field77J(String value)

Creates the field parsing the parameter value into fields' components

Parameters:

value -

Method Detail

newInstance

public static Field77J newInstance(Field77J 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

getValue

public String getValue()

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

Overrides:

getValue in class Field

Returns:

SWIFT formatted value

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

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

getComponent1

public String getComponent1()

Get the component1

Returns:

the component1

getComponent1AsString

@Deprecated
public String getComponent1AsString()

Deprecated.

Same as getComponent(1)

setComponent1

public Field77J setComponent1(String component1)

Set the component1.

Parameters:

component1 - the component1 to set

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

componentsPattern

public String componentsPattern()

Specified by:

componentsPattern in interface PatternContainer

parserPattern

public String parserPattern()

Specified by:

parserPattern in interface PatternContainer

getName

public String getName()

Deprecated. use constant Field77J

Description copied from class: Field

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

Specified by:

getName in class Field

get

public static Field77J 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

get

public static Field77J get(SwiftMessage msg)

Get the first instance of Field77J 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 List<Field77J> getAll(SwiftMessage msg)

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

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

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

getLine

public 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 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 List<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 List<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 offset)}

getLinesBetween

public List<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 start, int end)}

getLinesBetween

public List<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)}