Field92D (Prowide Core API Reference)

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

All Implemented Interfaces:

AmountContainer, GenericField, PatternContainer, java.io.Serializable
```
@Generated
public class Field92D
extends Field
implements java.io.Serializable, AmountContainer, GenericField
```
SWIFT MT Field 92D
Model and parser for field 92D of a SWIFT MT message.
Subfields (components) Data types
1. String
2. Number
3. Number
Structure definition
- validation pattern: :4!c//<AMOUNT>15/<AMOUNT>15
- parser pattern: :S//N/N
- components pattern: SNN
This class complies with standard release SRU2017

NOTE: this source code has been generated from template
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENTS_PATTERN`
`static java.lang.Integer`	`CONDITIONAL_QUALIFIER` Component number for the conditional qualifier subfield
`static java.lang.String`	`F_92D` same as NAME, intended to be clear when using static imports
`static java.lang.String`	`NAME` Constant with the field name 92D
`static java.lang.String`	`PARSER_PATTERN`
`static java.lang.Integer`	`QUALIFIER` Component number for the Qualifier subfield
`static java.lang.Integer`	`QUANTITY1` Component number for the Quantity1 subfield
`static java.lang.Integer`	`QUANTITY2` Component number for the Quantity2 subfield
`static int`	`SRU` Constant identifying the SRU to which this class belongs to.

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

Constructor Summary

Constructors
Constructor and Description
`Field92D()` Default constructor.
`Field92D(java.lang.String value)` Creates a new field and initializes its components with content from the parameter value.
`Field92D(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.math.BigDecimal`	`amount()` Get the first amount in this field.
`java.util.List<java.math.BigDecimal>`	`amounts()`
`java.lang.String`	`componentsPattern()` Returns the field's components pattern
`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 Field92D`	`get(SwiftMessage msg)` Get the first instance of Field92D in the given message.
`static Field92D`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static java.util.List<Field92D>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field92D in the given message an empty list is returned if none found.
`static java.util.List<Field92D>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field92D from the given block an empty list is returned if none found.
`java.lang.String`	`getComponent1()` Get the component1
`java.lang.String`	`getComponent1AsString()` Deprecated. use `Field.getComponent(int)` instead
`java.lang.String`	`getComponent2()` Get the component2
`java.lang.Number`	`getComponent2AsNumber()` Get the component2 as Number
`java.lang.String`	`getComponent3()` Get the component3
`java.lang.Number`	`getComponent3AsNumber()` Get the component3 as Number
`protected java.util.List<java.lang.String>`	`getComponentLabels()` Returns english label for components.
`java.lang.String`	`getConditionalQualifier()` Gets the conditional qualifier. The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.
`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)
`java.lang.String`	`getQualifier()` Get the Qualifier (component1).
`java.lang.String`	`getQuantity1()` Get the Quantity1 (component2).
`java.lang.Number`	`getQuantity1AsNumber()` Get the Quantity1 (component2) as Number
`java.lang.String`	`getQuantity2()` Get the Quantity2 (component3).
`java.lang.Number`	`getQuantity2AsNumber()` Get the Quantity2 (component3) as Number
`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 Field92D`	`newInstance(Field92D source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`void`	`parse(java.lang.String value)` Parses the parameter value into the internal components structure.
`java.lang.String`	`parserPattern()`
`Field92D`	`setComponent1(java.lang.String component1)` Set the component1.
`Field92D`	`setComponent2(java.lang.Number component2)` Set the component2 from a Number object.
`Field92D`	`setComponent2(java.lang.String component2)` Set the component2.
`Field92D`	`setComponent3(java.lang.Number component3)` Set the component3 from a Number object.
`Field92D`	`setComponent3(java.lang.String component3)` Set the component3.
`Field92D`	`setQualifier(java.lang.String component1)` Set the Qualifier (component1).
`Field92D`	`setQuantity1(java.lang.Number component2)` Set the Quantity1 (component2) from a Number object.
`Field92D`	`setQuantity1(java.lang.String component2)` Set the Quantity1 (component2).
`Field92D`	`setQuantity2(java.lang.Number component3)` Set the Quantity2 (component3) from a Number object.
`Field92D`	`setQuantity2(java.lang.String component3)` Set the Quantity2 (component3).
`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's validators 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, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isAnyOf, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, 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 92D
    
    See Also:
    
    Constant Field Values
  - F_92D
```
public static final java.lang.String F_92D
```
    same as NAME, intended to be clear when using static imports
    
    See Also:
    
    Constant Field Values
  - PARSER_PATTERN
```
public static final java.lang.String PARSER_PATTERN
```
    See Also:
    
    Constant Field Values
  - COMPONENTS_PATTERN
```
public static final java.lang.String COMPONENTS_PATTERN
```
    See Also:
    
    Constant Field Values
  - QUALIFIER
```
public static final java.lang.Integer QUALIFIER
```
    Component number for the Qualifier subfield
  - QUANTITY1
```
public static final java.lang.Integer QUANTITY1
```
    Component number for the Quantity1 subfield
  - QUANTITY2
```
public static final java.lang.Integer QUANTITY2
```
    Component number for the Quantity2 subfield
  - CONDITIONAL_QUALIFIER
```
public static final java.lang.Integer CONDITIONAL_QUALIFIER
```
    Component number for the conditional qualifier subfield
- Constructor Detail
  - Field92D
```
public Field92D()
```
    Default constructor. Creates a new field setting all components to null.
  - Field92D
```
public Field92D(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
  - Field92D
```
public Field92D(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
  - 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
  - newInstance
```
public static Field92D newInstance(Field92D 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 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
  - 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
  - getComponent1
```
public java.lang.String getComponent1()
```
    Get the component1
    
    Returns:
    
    the component1
  - getComponent1AsString
```
@Deprecated
 @ProwideDeprecated(phase2=_2018)
public java.lang.String getComponent1AsString()
```
    Deprecated. use Field.getComponent(int) instead
    
    Same as getComponent(1)
  - getQualifier
```
public java.lang.String getQualifier()
```
    Get the Qualifier (component1).
    
    Returns:
    
    the Qualifier from component1
  - setComponent1
```
public Field92D setComponent1(java.lang.String component1)
```
    Set the component1.
    
    Parameters:
    
    component1 - the component1 to set
  - setQualifier
```
public Field92D setQualifier(java.lang.String component1)
```
    Set the Qualifier (component1).
    
    Parameters:
    
    component1 - the Qualifier to set
  - getComponent2
```
public java.lang.String getComponent2()
```
    Get the component2
    
    Returns:
    
    the component2
  - getComponent2AsNumber
```
public java.lang.Number getComponent2AsNumber()
```
    Get the component2 as Number
    
    Returns:
    
    the component2 converted to Number or null if cannot be converted
  - getQuantity1
```
public java.lang.String getQuantity1()
```
    Get the Quantity1 (component2).
    
    Returns:
    
    the Quantity1 from component2
  - getQuantity1AsNumber
```
public java.lang.Number getQuantity1AsNumber()
```
    Get the Quantity1 (component2) as Number
    
    Returns:
    
    the Quantity1 from component2 converted to Number or null if cannot be converted
  - setComponent2
```
public Field92D setComponent2(java.lang.String component2)
```
    Set the component2.
    
    Parameters:
    
    component2 - the component2 to set
  - setComponent2
```
public Field92D setComponent2(java.lang.Number component2)
```
    Set the component2 from a Number object.
    Parses the Number into a SWIFT amount with truncated zero decimals and mandatory decimal separator.
    - Example: 1234.00 -> 1234,
    - Example: 1234 -> 1234,
    - Example: 1234.56 -> 1234,56
    Parameters:
    
    component2 - the Number with the component2 content to set
  - setQuantity1
```
public Field92D setQuantity1(java.lang.String component2)
```
    Set the Quantity1 (component2).
    
    Parameters:
    
    component2 - the Quantity1 to set
  - setQuantity1
```
public Field92D setQuantity1(java.lang.Number component2)
```
    Set the Quantity1 (component2) from a Number object.
    
    Parameters:
    
    component2 - Number with the Quantity1 content to set
    
    See Also:
    
    setComponent2(java.lang.Number)
  - getComponent3
```
public java.lang.String getComponent3()
```
    Get the component3
    
    Returns:
    
    the component3
  - getComponent3AsNumber
```
public java.lang.Number getComponent3AsNumber()
```
    Get the component3 as Number
    
    Returns:
    
    the component3 converted to Number or null if cannot be converted
  - getQuantity2
```
public java.lang.String getQuantity2()
```
    Get the Quantity2 (component3).
    
    Returns:
    
    the Quantity2 from component3
  - getQuantity2AsNumber
```
public java.lang.Number getQuantity2AsNumber()
```
    Get the Quantity2 (component3) as Number
    
    Returns:
    
    the Quantity2 from component3 converted to Number or null if cannot be converted
  - setComponent3
```
public Field92D setComponent3(java.lang.String component3)
```
    Set the component3.
    
    Parameters:
    
    component3 - the component3 to set
  - setComponent3
```
public Field92D setComponent3(java.lang.Number component3)
```
    Set the component3 from a Number object.
    Parses the Number into a SWIFT amount with truncated zero decimals and mandatory decimal separator.
    - Example: 1234.00 -> 1234,
    - Example: 1234 -> 1234,
    - Example: 1234.56 -> 1234,56
    Parameters:
    
    component3 - the Number with the component3 content to set
  - setQuantity2
```
public Field92D setQuantity2(java.lang.String component3)
```
    Set the Quantity2 (component3).
    
    Parameters:
    
    component3 - the Quantity2 to set
  - setQuantity2
```
public Field92D setQuantity2(java.lang.Number component3)
```
    Set the Quantity2 (component3) from a Number object.
    
    Parameters:
    
    component3 - Number with the Quantity2 content to set
    
    See Also:
    
    setComponent3(java.lang.Number)
  - amounts
```
public java.util.List<java.math.BigDecimal> amounts()
```
    See Also:
    
    AmountResolver.amounts(Field)
  - amount
```
public java.math.BigDecimal amount()
```
    Description copied from interface: AmountContainer
    
    Get the first amount in this field.
    
    Specified by:
    
    amount in interface AmountContainer
    
    See Also:
    
    AmountResolver.amount(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
  - 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
    
    Overrides:
    
    getDSS in class Field
    
    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
    
    Overrides:
    
    isDSSPresent in class Field
    
    Returns:
    
    true if DSS is present, false otherwise.
    
    See Also:
    
    getDSS()
  - getConditionalQualifier
```
public java.lang.String getConditionalQualifier()
```
    Gets the conditional qualifier.
    The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.
    
    Specified by:
    
    getConditionalQualifier in interface GenericField
    
    Overrides:
    
    getConditionalQualifier in class Field
    
    Returns:
    
    for generic fields returns the value of the conditional qualifier or null if not set or not applicable for this kind of field.
  - parserPattern
```
public java.lang.String parserPattern()
```
    Specified by:
    
    parserPattern in interface PatternContainer
  - 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 Field92D.NAME
  - componentsPattern
```
public final java.lang.String componentsPattern()
```
    Returns the field's components pattern
    
    Specified by:
    
    componentsPattern in interface PatternContainer
    
    Specified by:
    
    componentsPattern in class Field
    
    Returns:
    
    the static value of Field92D.COMPONENTS_PATTERN
  - validatorPattern
```
public final java.lang.String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field92D 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 Field92D get(SwiftMessage msg)
```
    Get the first instance of Field92D 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<Field92D> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field92D 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<Field92D> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field92D 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
  - 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
  - getComponentLabels
```
protected 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)

Class Field92D

SWIFT MT Field 92D

Subfields (components) Data types

Structure definition

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_92D

PARSER_PATTERN

COMPONENTS_PATTERN

QUALIFIER

QUANTITY1

QUANTITY2

CONDITIONAL_QUALIFIER

Constructor Detail

Field92D

Field92D

Field92D

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsString

getQualifier

setComponent1

setQualifier

getComponent2

getComponent2AsNumber

getQuantity1

getQuantity1AsNumber

setComponent2

setComponent2

setQuantity1

setQuantity1

getComponent3

getComponent3AsNumber

getQuantity2

getQuantity2AsNumber

setComponent3

setComponent3

setQuantity2

setQuantity2

amounts

amount

isOptional

isGeneric

getDSS

isDSSPresent

getConditionalQualifier

parserPattern

getName

componentsPattern

validatorPattern

get

get

getAll

getAll

componentsSize

getValueDisplay

getComponentLabels