com.prowidesoftware.swift.model.field

Class Field95Q

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.OptionQPartyField

com.prowidesoftware.swift.model.field.Field95Q

All Implemented Interfaces:

JsonSerializable, GenericField, MultiLineField, PatternContainer, java.io.Serializable

@Generated
public class Field95Q
extends OptionQPartyField
implements java.io.Serializable, GenericField, MultiLineField

SWIFT MT Field 95Q.

Model and parser for field 95Q of a SWIFT MT message.

Subfields (components) Data types

1. Component 1: Qualifier: String
2. Component 2: NameAndAddress: String
3. Component 3: NameAndAddress2: String
4. Component 4: NameAndAddress3: String
5. Component 5: NameAndAddress4: String

Structure definition

• validation pattern: :4!c//35x[$35x]0-3(***)
• parser pattern: :S//S[$S]0-3
• components pattern: SSSSS

This class complies with standard release SRU2024

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	CONDITIONAL_QUALIFIER Component number for the conditional qualifier subfield.
static java.lang.String	F_95Q Same as NAME, intended to be clear when using static imports.
static java.lang.String	NAME Constant with the field name 95Q.
static int	SRU Constant identifying the SRU to which this class belongs to.

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

NAME_AND_ADDRESS, PARSER_PATTERN, QUALIFIER, TYPES_PATTERN

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

components, labelMap

Constructor Summary

Constructors

Constructor and Description
Field95Q() Default constructor.
Field95Q(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field95Q(Tag tag) Creates a new field and initializes its components with content from the parameter tag.

Method Summary

Modifier and Type	Method and Description
static Tag	emptyTag() Create a Tag with this field name and an empty string as value.
static Field95Q	fromJson(java.lang.String json) This method deserializes the JSON data into a Field95Q object.
static Field95Q	get(SwiftMessage msg) Gets the first instance of Field95Q in the given message.
static Field95Q	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field95Q>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field95Q in the given message an empty list is returned if none found.
static java.util.List<Field95Q>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field95Q from the given block an empty list is returned if none found.
java.lang.String	getConditionalQualifier() Gets the component with the conditional (secondary) qualifier.
java.lang.String	getDSS() Returns the issuer code (or Data Source Scheme or DSS).
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).
boolean	isDSSPresent() Checks if the issuer code (or Data Source Scheme or DSS) is present.
static Field95Q	newInstance(Field95Q source) Copy constructor.
Field95Q	setComponent1(java.lang.String component1) Set the component 1 (Qualifier).
Field95Q	setComponent2(java.lang.String component2) Set the component 2 (Name And Address).
Field95Q	setComponent3(java.lang.String component3) Set the component 3 (Name And Address 2).
Field95Q	setComponent4(java.lang.String component4) Set the component 4 (Name And Address 3).
Field95Q	setComponent5(java.lang.String component5) Set the component 5 (Name And Address 4).
Field95Q	setNameAndAddress(java.lang.String value) Set the Name And Address splitting the parameter lines into components 2 to 5.
Field95Q	setNameAndAddressLine1(java.lang.String component2) Set the Name And Address (component 2).
Field95Q	setNameAndAddressLine2(java.lang.String component3) Set the Name And Address 2 (component 3).
Field95Q	setNameAndAddressLine3(java.lang.String component4) Set the Name And Address 3 (component 4).
Field95Q	setNameAndAddressLine4(java.lang.String component5) Set the Name And Address 4 (component 5).
Field95Q	setQualifier(java.lang.String component1) Set the Qualifier (component 1).
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.OptionQPartyField

componentsSize, getComponent1, getComponent2, getComponent3, getComponent4, getComponent5, getComponentLabels, getComponentMap, getLabelMap, getNameAndAddress, getNameAndAddressLine1, getNameAndAddressLine2, getNameAndAddressLine3, getNameAndAddressLine4, getQualifier, getValue, getValueDisplay, isGeneric, isOptional, parse, parserPattern, typesPattern

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 95Q.

See Also:

Constant Field Values

F_95Q

public static final java.lang.String F_95Q

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

See Also:

Constant Field Values

CONDITIONAL_QUALIFIER

public static final java.lang.Integer CONDITIONAL_QUALIFIER

Component number for the conditional qualifier subfield.

Constructor Detail

Field95Q

public Field95Q()

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

Field95Q

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

Field95Q

public Field95Q(Tag tag)

Creates a new field and initializes its components with content from the parameter tag. The value is parsed with OptionQPartyField.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 Field95Q newInstance(Field95Q 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

validatorPattern

public final java.lang.String validatorPattern()

Returns the field validator pattern.

Specified by:

validatorPattern in class OptionQPartyField

setComponent1

public Field95Q setComponent1(java.lang.String component1)

Set the component 1 (Qualifier).

Parameters:

component1 - the Qualifier to set

Returns:

the field object to enable build pattern

setQualifier

public Field95Q setQualifier(java.lang.String component1)

Set the Qualifier (component 1).

Parameters:

component1 - the Qualifier to set

Returns:

the field object to enable build pattern

setComponent2

public Field95Q setComponent2(java.lang.String component2)

Set the component 2 (Name And Address).

Parameters:

component2 - the Name And Address to set

Returns:

the field object to enable build pattern

setNameAndAddressLine1

public Field95Q setNameAndAddressLine1(java.lang.String component2)

Set the Name And Address (component 2).

Parameters:

component2 - the Name And Address to set

Returns:

the field object to enable build pattern

setNameAndAddress

public Field95Q setNameAndAddress(java.lang.String value)

Set the Name And Address splitting the parameter lines into components 2 to 5.

Parameters:

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

Returns:

the field object to enable build pattern

setComponent3

public Field95Q setComponent3(java.lang.String component3)

Set the component 3 (Name And Address 2).

Parameters:

component3 - the Name And Address 2 to set

Returns:

the field object to enable build pattern

setNameAndAddressLine2

public Field95Q setNameAndAddressLine2(java.lang.String component3)

Set the Name And Address 2 (component 3).

Parameters:

component3 - the Name And Address 2 to set

Returns:

the field object to enable build pattern

setComponent4

public Field95Q setComponent4(java.lang.String component4)

Set the component 4 (Name And Address 3).

Parameters:

component4 - the Name And Address 3 to set

Returns:

the field object to enable build pattern

setNameAndAddressLine3

public Field95Q setNameAndAddressLine3(java.lang.String component4)

Set the Name And Address 3 (component 4).

Parameters:

component4 - the Name And Address 3 to set

Returns:

the field object to enable build pattern

setComponent5

public Field95Q setComponent5(java.lang.String component5)

Set the component 5 (Name And Address 4).

Parameters:

component5 - the Name And Address 4 to set

Returns:

the field object to enable build pattern

setNameAndAddressLine4

public Field95Q setNameAndAddressLine4(java.lang.String component5)

Set the Name And Address 4 (component 5).

Parameters:

component5 - the Name And Address 4 to set

Returns:

the field object to enable build pattern

getDSS

public java.lang.String getDSS()

Returns the issuer code (or Data Source Scheme or DSS). The DSS is only present in some generic fields, when present, is equals to component two.

Specified by:

getDSS in interface GenericField

Returns:

DSS component value or null if the DSS is not set or not available for this field.

isDSSPresent

public boolean isDSSPresent()

Checks if the issuer code (or Data Source Scheme or DSS) is present.

Specified by:

isDSSPresent in interface GenericField

Returns:

true if DSS is present, false otherwise.

See Also:

getDSS()

getConditionalQualifier

public java.lang.String getConditionalQualifier()

Gets the component with the conditional (secondary) qualifier.

Specified by:

getConditionalQualifier in interface GenericField

Returns:

for generic fields returns the value of the conditional qualifier or null if not set or not applicable for this field.

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 OptionQPartyField

Returns:

the static value of Field95Q.NAME

get

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

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

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

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

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