com.prowidesoftware.swift.model.field

Class Field95R

java.lang.Object

com.prowidesoftware.swift.model.field.Field

com.prowidesoftware.swift.model.field.OptionRPartyField

com.prowidesoftware.swift.model.field.Field95R

All Implemented Interfaces:

JsonSerializable, GenericField, PatternContainer, java.io.Serializable

@Generated
public class Field95R
extends OptionRPartyField
implements java.io.Serializable, GenericField

SWIFT MT Field 95R.

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

Subfields (components) Data types

1. Component 1: Qualifier: String
2. Component 2: DataSourceScheme: String
3. Component 3: ProprietaryCode: String

Structure definition

• validation pattern: :4!c/8c/34x(***)
• parser pattern: :S/S/S
• components pattern: SSS

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_95R Same as NAME, intended to be clear when using static imports.
static java.lang.String	NAME Constant with the field name 95R.
static int	SRU Constant identifying the SRU to which this class belongs to.

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

DATA_SOURCE_SCHEME, PARSER_PATTERN, PROPRIETARY_CODE, QUALIFIER, TYPES_PATTERN

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

components, labelMap

Constructor Summary

Constructors

Constructor and Description
Field95R() Default constructor.
Field95R(java.lang.String value) Creates a new field and initializes its components with content from the parameter value.
Field95R(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 Field95R	fromJson(java.lang.String json) This method deserializes the JSON data into a Field95R object.
static Field95R	get(SwiftMessage msg) Gets the first instance of Field95R in the given message.
static Field95R	get(SwiftTagListBlock block) Gets the first occurrence form the tag list or null if not found.
static java.util.List<Field95R>	getAll(SwiftMessage msg) Gets a list of all occurrences of the field Field95R in the given message an empty list is returned if none found.
static java.util.List<Field95R>	getAll(SwiftTagListBlock block) Gets a list of all occurrences of the field Field95R 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	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 Field95R	newInstance(Field95R source) Copy constructor.
Field95R	setComponent1(java.lang.String component1) Set the component 1 (Qualifier).
Field95R	setComponent2(java.lang.String component2) Set the component 2 (Data Source Scheme).
Field95R	setComponent3(java.lang.String component3) Set the component 3 (Proprietary Code).
Field95R	setDataSourceScheme(java.lang.String component2) Set the Data Source Scheme (component 2).
Field95R	setProprietaryCode(java.lang.String component3) Set the Proprietary Code (component 3).
Field95R	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.OptionRPartyField

componentsSize, getComponent1, getComponent2, getComponent3, getComponentLabels, getComponentMap, getDataSourceScheme, getLabelMap, getProprietaryCode, 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 95R.

See Also:

Constant Field Values

F_95R

public static final java.lang.String F_95R

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

Field95R

public Field95R()

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

Field95R

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

Field95R

public Field95R(Tag tag)

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

setComponent1

public Field95R 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 Field95R 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 Field95R setComponent2(java.lang.String component2)

Set the component 2 (Data Source Scheme).

Parameters:

component2 - the Data Source Scheme to set

Returns:

the field object to enable build pattern

setDataSourceScheme

public Field95R setDataSourceScheme(java.lang.String component2)

Set the Data Source Scheme (component 2).

Parameters:

component2 - the Data Source Scheme to set

Returns:

the field object to enable build pattern

setComponent3

public Field95R setComponent3(java.lang.String component3)

Set the component 3 (Proprietary Code).

Parameters:

component3 - the Proprietary Code to set

Returns:

the field object to enable build pattern

setProprietaryCode

public Field95R setProprietaryCode(java.lang.String component3)

Set the Proprietary Code (component 3).

Parameters:

component3 - the Proprietary Code 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 OptionRPartyField

Returns:

the static value of Field95R.NAME

get

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

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

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

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

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