Field12B (Prowide Core API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.field.Field
- - com.prowidesoftware.swift.model.field.Field12B

All Implemented Interfaces:

JsonSerializable, GenericField, PatternContainer, java.io.Serializable
```
@Generated
public class Field12B
extends Field
implements java.io.Serializable, GenericField
```
SWIFT MT Field 12B.
Model and parser for field 12B of a SWIFT MT message.
Subfields (components) Data types
1. String
2. String
3. String
Structure definition
- validation pattern: :4!c/[8c]/4!c
- parser pattern: :S/[S]/S
- components pattern: SSS
This class complies with standard release SRU2021
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENTS_PATTERN` Deprecated. Use `typesPattern()` method instead.
`static java.lang.Integer`	`CONDITIONAL_QUALIFIER` Component number for the conditional qualifier subfield.
`static java.lang.Integer`	`DATA_SOURCE_SCHEME` Component number for the Data Source Scheme subfield.
`static java.lang.String`	`F_12B` Same as NAME, intended to be clear when using static imports.
`static java.lang.Integer`	`INSTRUMENT_TYPE_CODE` Component number for the Instrument Type Code subfield.
`static java.lang.String`	`NAME` Constant with the field name 12B.
`static java.lang.String`	`PARSER_PATTERN` Deprecated. Use `parserPattern()` method instead.
`static java.lang.Integer`	`QUALIFIER` Component number for the Qualifier subfield.
`static int`	`SRU` Constant identifying the SRU to which this class belongs to.
`static java.lang.Integer`	`TYPE` Alternative constant name for field's Instrument Type Code Component number.
`static java.lang.String`	`TYPES_PATTERN` Deprecated. Use `typesPattern()` method instead.

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

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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 Field12B`	`fromJson(java.lang.String json)` This method deserializes the JSON data into a Field12B object.
`static Field12B`	`get(SwiftMessage msg)` Gets the first instance of Field12B in the given message.
`static Field12B`	`get(SwiftTagListBlock block)` Gets the first occurrence form the tag list or null if not found.
`static java.util.List<Field12B>`	`getAll(SwiftMessage msg)` Gets a list of all occurrences of the field Field12B in the given message an empty list is returned if none found.
`static java.util.List<Field12B>`	`getAll(SwiftTagListBlock block)` Gets a list of all occurrences of the field Field12B from the given block an empty list is returned if none found.
`java.lang.String`	`getComponent1()` Gets the component 1 (Qualifier).
`java.lang.String`	`getComponent2()` Gets the component 2 (Data Source Scheme).
`java.lang.String`	`getComponent3()` Gets the component 3 (Instrument Type Code).
`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.
`java.lang.String`	`getConditionalQualifier()` Gets the component with the conditional (secondary) qualifier.
`java.lang.String`	`getDataSourceScheme()` Gets the Data Source Scheme (component 2).
`java.lang.String`	`getDSS()` Returns the issuer code (or Data Source Scheme or DSS).
`java.lang.String`	`getInstrumentTypeCode()` Gets the Instrument Type Code (component 3).
`java.lang.String`	`getName()` Returns the field's name composed by the field number and the letter option (if any).
`java.lang.String`	`getQualifier()` Gets the Qualifier (component 1).
`java.lang.String`	`getType()` Alternative method getter for field's Instrument Type Code
`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`	`isDSSPresent()` Checks if the issuer code (or Data Source Scheme or DSS) is present.
`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 Field12B`	`newInstance(Field12B 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.
`Field12B`	`setComponent1(java.lang.String component1)` Set the component 1 (Qualifier).
`Field12B`	`setComponent2(java.lang.String component2)` Set the component 2 (Data Source Scheme).
`Field12B`	`setComponent3(java.lang.String component3)` Set the component 3 (Instrument Type Code).
`Field12B`	`setDataSourceScheme(java.lang.String component2)` Set the Data Source Scheme (component 2).
`Field12B`	`setInstrumentTypeCode(java.lang.String component3)` Set the Instrument Type Code (component 3).
`Field12B`	`setQualifier(java.lang.String component1)` Set the Qualifier (component 1).
`Field12B`	`setType(java.lang.String component3)` Alternative method setter for field's Instrument Type Code
`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, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, 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 12B.
    
    See Also:
    
    Constant Field Values
  - F_12B
```
public static final java.lang.String F_12B
```
    Same as NAME, intended to be clear when using static imports.
    
    See Also:
    
    Constant Field Values
  - PARSER_PATTERN
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.String PARSER_PATTERN
```
    Deprecated. Use parserPattern() method instead.
    
    See Also:
    
    Constant Field Values
  - COMPONENTS_PATTERN
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.String COMPONENTS_PATTERN
```
    Deprecated. Use typesPattern() method instead.
    
    See Also:
    
    Constant Field Values
  - TYPES_PATTERN
```
@Deprecated
 @ProwideDeprecated(phase2=SRU2022)
public static final java.lang.String TYPES_PATTERN
```
    Deprecated. Use typesPattern() method instead.
    
    See Also:
    
    Constant Field Values
  - QUALIFIER
```
public static final java.lang.Integer QUALIFIER
```
    Component number for the Qualifier subfield.
  - DATA_SOURCE_SCHEME
```
public static final java.lang.Integer DATA_SOURCE_SCHEME
```
    Component number for the Data Source Scheme subfield.
  - INSTRUMENT_TYPE_CODE
```
public static final java.lang.Integer INSTRUMENT_TYPE_CODE
```
    Component number for the Instrument Type Code subfield.
  - TYPE
```
public static final java.lang.Integer TYPE
```
    Alternative constant name for field's Instrument Type Code Component number.
    
    See Also:
    
    INSTRUMENT_TYPE_CODE
  - CONDITIONAL_QUALIFIER
```
public static final java.lang.Integer CONDITIONAL_QUALIFIER
```
    Component number for the conditional qualifier subfield.
- Constructor Detail
  - Field12B
```
public Field12B()
```
    Default constructor. Creates a new field setting all components to null.
  - Field12B
```
public Field12B(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
  - Field12B
```
public Field12B(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 Field12B newInstance(Field12B 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(phase2=SRU2022)
public java.lang.String componentsPattern()
```
    Deprecated. Use typesPattern() instead.
    
    Description copied from class: Field
    
    Returns the field components pattern This method is DEPRECATED, use typesPattern() instead.
    
    Specified by:
    
    componentsPattern in class Field
    
    Returns:
    
    the static value of Field${dto.getField()}.COMPONENTS_PATTERN
    
    See Also:
    
    Field.typesPattern()
  - 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
  - getComponent1
```
public java.lang.String getComponent1()
```
    Gets the component 1 (Qualifier).
    
    Returns:
    
    the component 1
  - getQualifier
```
public java.lang.String getQualifier()
```
    Gets the Qualifier (component 1).
    
    Returns:
    
    the Qualifier from component 1
  - getComponent2
```
public java.lang.String getComponent2()
```
    Gets the component 2 (Data Source Scheme).
    
    Returns:
    
    the component 2
  - getDataSourceScheme
```
public java.lang.String getDataSourceScheme()
```
    Gets the Data Source Scheme (component 2).
    
    Returns:
    
    the Data Source Scheme from component 2
  - getComponent3
```
public java.lang.String getComponent3()
```
    Gets the component 3 (Instrument Type Code).
    
    Returns:
    
    the component 3
  - getInstrumentTypeCode
```
public java.lang.String getInstrumentTypeCode()
```
    Gets the Instrument Type Code (component 3).
    
    Returns:
    
    the Instrument Type Code from component 3
  - getType
```
public java.lang.String getType()
```
    Alternative method getter for field's Instrument Type Code
    
    Since:
    
    9.2.7
    
    See Also:
    
    getInstrumentTypeCode()
  - setComponent1
```
public Field12B 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 Field12B 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 Field12B 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 Field12B 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 Field12B setComponent3(java.lang.String component3)
```
    Set the component 3 (Instrument Type Code).
    
    Parameters:
    
    component3 - the Instrument Type Code to set
    
    Returns:
    
    the field object to enable build pattern
  - setInstrumentTypeCode
```
public Field12B setInstrumentTypeCode(java.lang.String component3)
```
    Set the Instrument Type Code (component 3).
    
    Parameters:
    
    component3 - the Instrument Type Code to set
    
    Returns:
    
    the field object to enable build pattern
  - setType
```
public Field12B setType(java.lang.String component3)
```
    Alternative method setter for field's Instrument Type Code
    
    Parameters:
    
    component3 - the Instrument Type Code to set
    
    Returns:
    
    the field object to enable build pattern
    
    See Also:
    
    setInstrumentTypeCode(String)
  - 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 Field
    
    Returns:
    
    the static value of Field12B.NAME
  - get
```
public static Field12B 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 Field12B get(SwiftMessage msg)
```
    Gets the first instance of Field12B 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<Field12B> getAll(SwiftMessage msg)
```
    Gets a list of all occurrences of the field Field12B 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<Field12B> getAll(SwiftTagListBlock block)
```
    Gets a list of all occurrences of the field Field12B 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 Field12B fromJson(java.lang.String json)
```
    This method deserializes the JSON data into a Field12B 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)

Class Field12B

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

SRU

NAME

F_12B

PARSER_PATTERN

COMPONENTS_PATTERN

TYPES_PATTERN

QUALIFIER

DATA_SOURCE_SCHEME

INSTRUMENT_TYPE_CODE

TYPE

CONDITIONAL_QUALIFIER

Constructor Detail

Field12B

Field12B

Field12B

Method Detail

newInstance

tag

emptyTag

parse

getValue

getValueDisplay

componentsPattern

typesPattern

parserPattern

validatorPattern

isOptional

isGeneric

componentsSize

getComponentLabels

getComponentMap

getComponent1

getQualifier

getComponent2

getDataSourceScheme

getComponent3

getInstrumentTypeCode

getType

setComponent1

setQualifier

setComponent2

setDataSourceScheme

setComponent3

setInstrumentTypeCode

setType

getDSS

isDSSPresent

getConditionalQualifier

getName

get

get

getAll

getAll

fromJson