Package com.prowidesoftware.swift.model.field

Class Field13K

  • All Implemented Interfaces:
    JsonSerializable, AmountContainer, GenericField, PatternContainer, java.io.Serializable
    @Generated
public class Field13K
extends Field
implements java.io.Serializable, AmountContainer, GenericField
    SWIFT MT Field 13K.

    Model and parser for field 13K of a SWIFT MT message.

    Subfields (components) Data types

    1. Component 1: Qualifier: String
    2. Component 2: NumberId: String
    3. Component 3: Quantity: BigDecimal

    Structure definition

    • validation pattern: :4!c//3!c/<AMOUNT>15
    • parser pattern: :S//S/N
    • components pattern: SSN

    This class complies with standard release SRU2023

    See Also:
    Serialized Form

    • 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 13K.
        See Also:
        Constant Field Values

      • F_13K

        public static final java.lang.String F_13K
        Same as NAME, intended to be clear when using static imports.
        See Also:
        Constant Field Values

      • QUALIFIER

        public static final java.lang.Integer QUALIFIER
        Component number for the Qualifier subfield.

      • NUMBER_ID

        public static final java.lang.Integer NUMBER_ID
        Component number for the Number Id subfield.

      • QUANTITY

        public static final java.lang.Integer QUANTITY
        Component number for the Quantity subfield.

      • CONDITIONAL_QUALIFIER

        public static final java.lang.Integer CONDITIONAL_QUALIFIER
        Component number for the conditional qualifier subfield.

    • Constructor Detail

      • Field13K

        public Field13K()
        Default constructor. Creates a new field setting all components to null.

      • Field13K

        public Field13K​(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

      • Field13K

        public Field13K​(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 Field13K newInstance​(Field13K 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

      • 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

      • getLabelMap

        protected java.util.Map<java.lang.String,​java.lang.Integer> getLabelMap()
        Description copied from class: Field
        Returns a mapping between component labels and the internal component number. Component labels are in lowercase and without spaces and separators. If a for a given component there is more than one label option, both are mapped to the same component number.
        Specified by:
        getLabelMap in class Field
        Since:
        9.3.12
        See Also:
        Field.getLabelMap()

      • 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 (Number Id).
        Returns:
        the component 2

      • getNumberId

        public java.lang.String getNumberId()
        Gets the Number Id (component 2).
        Returns:
        the Number Id from component 2

      • getComponent3

        public java.lang.String getComponent3()
        Gets the component 3 (Quantity).
        Returns:
        the component 3

      • getComponent3AsBigDecimal

        public java.math.BigDecimal getComponent3AsBigDecimal()
        Get the component 3 as BigDecimal
        Returns:
        the component 3 converted to BigDecimal or null if cannot be converted
        Since:
        9.2.7

      • getComponent3AsNumber

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.Number getComponent3AsNumber()
        Deprecated.
        use #getComponent3AsBigDecimal() instead

      • getQuantity

        public java.lang.String getQuantity()
        Gets the Quantity (component 3).
        Returns:
        the Quantity from component 3

      • getAmount

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.String getAmount()
        Deprecated.
        use #getQuantity() instead
        Alternative DEPRECATED method getter for field's Quantity
        Since:
        9.2.7

      • getQuantityAsBigDecimal

        public java.math.BigDecimal getQuantityAsBigDecimal()
        Get the Quantity (component 3) as BigDecimal
        Returns:
        the Quantity from component 3 converted to BigDecimal or null if cannot be converted
        Since:
        9.2.7

      • getQuantityAsNumber

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.Number getQuantityAsNumber()
        Deprecated.
        use #getQuantityAsBigDecimal() instead

      • getAmountAsBigDecimal

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.math.BigDecimal getAmountAsBigDecimal()
        Deprecated.
        use #getQuantityAsBigDecimal() instead

      • getAmountAsNumber

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.Number getAmountAsNumber()
        Deprecated.
        use #getQuantityAsBigDecimal() instead

      • setComponent1

        public Field13K 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 Field13K 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 Field13K setComponent2​(java.lang.String component2)
        Set the component 2 (Number Id).
        Parameters:
        component2 - the Number Id to set
        Returns:
        the field object to enable build pattern

      • setNumberId

        public Field13K setNumberId​(java.lang.String component2)
        Set the Number Id (component 2).
        Parameters:
        component2 - the Number Id to set
        Returns:
        the field object to enable build pattern

      • setComponent3

        public Field13K setComponent3​(java.lang.String component3)
        Set the component 3 (Quantity).
        Parameters:
        component3 - the Quantity to set
        Returns:
        the field object to enable build pattern

      • setComponent3

        public Field13K setComponent3​(java.math.BigDecimal component3)
        Set the component3 from a BigDecimal object.
        Parses the BigDecimal 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 BigDecimal with the Quantity content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7

      • setComponent3

        public Field13K setComponent3​(java.lang.Number component3)
        Alternative method setter for field's Quantity (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
        Parameters:
        component3 - the Number with the Quantity content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setQuantity(java.math.BigDecimal)

      • setQuantity

        public Field13K setQuantity​(java.lang.String component3)
        Set the Quantity (component 3).
        Parameters:
        component3 - the Quantity to set
        Returns:
        the field object to enable build pattern

      • setQuantity

        public Field13K setQuantity​(java.math.BigDecimal component3)
        Set the Quantity (component 3) from a BigDecimal object.
        Parameters:
        component3 - BigDecimal with the Quantity content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent3(java.math.BigDecimal)

      • setQuantity

        public Field13K setQuantity​(java.lang.Number component3)
        Alternative method setter for field's Quantity (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component3 - the Number with the Quantity content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setQuantity(java.math.BigDecimal)

      • setAmount

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public Field13K setAmount​(java.math.BigDecimal component3)
        Deprecated.
        use #setComponent3(java.math.BigDecimal) instead
        Since:
        9.2.7

      • amounts

        public java.util.List<java.math.BigDecimal> amounts()
        Returns the list of all NON-NULL amounts as BigDecimal
        Returns:
        the list of NON-NULL amounts as BigDecimal values
        See Also:
        AmountResolver.amounts(Field)

      • 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 Field13K.NAME

      • get

        public static Field13K 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 Field13K get​(SwiftMessage msg)
        Gets the first instance of Field13K 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<Field13K> getAll​(SwiftMessage msg)
        Gets a list of all occurrences of the field Field13K 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<Field13K> getAll​(SwiftTagListBlock block)
        Gets a list of all occurrences of the field Field13K 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 Field13K fromJson​(java.lang.String json)
        This method deserializes the JSON data into a Field13K 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)