Package com.prowidesoftware.swift.model.field

Class Field32K

  • All Implemented Interfaces:
    JsonSerializable, AmountContainer, CurrencyContainer, MonetaryAmountContainer, PatternContainer, java.io.Serializable
    @Generated
public class Field32K
extends Field
implements java.io.Serializable, MonetaryAmountContainer
    SWIFT MT Field 32K.

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

    Subfields (components) Data types

    1. Component 1: DayMonth: String
    2. Component 2: NumberOfDaysMonths: Long
    3. Component 3: Code: String
    4. Component 4: Currency: Currency
    5. Component 5: Amount: BigDecimal

    Structure definition

    • validation pattern: <DM>3!n2!a<CUR><AMOUNT>15
    • parser pattern: cNS<CUR>N
    • components pattern: SNSCN

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

      • F_32K

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

      • DAYMONTH

        public static final java.lang.Integer DAYMONTH
        Component number for the DayMonth subfield.

      • NUMBER_OF_DAYSMONTHS

        public static final java.lang.Integer NUMBER_OF_DAYSMONTHS
        Component number for the Number Of Days/Months subfield.

      • CODE

        public static final java.lang.Integer CODE
        Component number for the Code subfield.

      • CURRENCY

        public static final java.lang.Integer CURRENCY
        Component number for the Currency subfield.

      • AMOUNT

        public static final java.lang.Integer AMOUNT
        Component number for the Amount subfield.

    • Constructor Detail

      • Field32K

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

      • Field32K

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

      • Field32K

        public Field32K​(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 Field32K newInstance​(Field32K 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 (DayMonth).
        Returns:
        the component 1

      • getDayMonth

        public java.lang.String getDayMonth()
        Gets the DayMonth (component 1).
        Returns:
        the DayMonth from component 1

      • getDMMark

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

      • getComponent2

        public java.lang.String getComponent2()
        Gets the component 2 (Number Of Days/Months).
        Returns:
        the component 2

      • getComponent2AsLong

        public java.lang.Long getComponent2AsLong()
        Get the component 2 as Long
        Returns:
        the component 2 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getComponent2AsNumber

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

      • getNumberOfDaysMonths

        public java.lang.String getNumberOfDaysMonths()
        Gets the Number Of Days/Months (component 2).
        Returns:
        the Number Of Days/Months from component 2

      • getNumberofDaysMonths

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.String getNumberofDaysMonths()
        Deprecated.
        use #getNumberOfDaysMonths() instead
        Alternative DEPRECATED method getter for field's Number Of Days/Months
        Since:
        9.2.7

      • getNumberOfDaysMonthsAsLong

        public java.lang.Long getNumberOfDaysMonthsAsLong()
        Get the Number Of Days/Months (component 2) as Long
        Returns:
        the Number Of Days/Months from component 2 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getNumberOfDaysMonthsAsNumber

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

      • getNumberofDaysMonthsAsLong

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.Long getNumberofDaysMonthsAsLong()
        Deprecated.
        use #getNumberOfDaysMonthsAsLong() instead

      • getNumberofDaysMonthsAsNumber

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

      • getComponent3

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

      • getCode

        public java.lang.String getCode()
        Gets the Code (component 3).
        Returns:
        the Code from component 3

      • getComponent4

        public java.lang.String getComponent4()
        Gets the component 4 (Currency).
        Returns:
        the component 4

      • getComponent4AsCurrency

        public java.util.Currency getComponent4AsCurrency()
        Get the component 4 as Currency
        Returns:
        the component 4 converted to Currency or null if cannot be converted

      • getCurrency

        public java.lang.String getCurrency()
        Gets the Currency (component 4).
        Returns:
        the Currency from component 4

      • getCurrencyAsCurrency

        public java.util.Currency getCurrencyAsCurrency()
        Get the Currency (component 4) as Currency
        Returns:
        the Currency from component 4 converted to Currency or null if cannot be converted

      • getComponent5

        public java.lang.String getComponent5()
        Gets the component 5 (Amount).
        Returns:
        the component 5

      • getComponent5AsBigDecimal

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

      • getComponent5AsNumber

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

      • getAmount

        public java.lang.String getAmount()
        Gets the Amount (component 5).
        Returns:
        the Amount from component 5

      • getAmountAsBigDecimal

        public java.math.BigDecimal getAmountAsBigDecimal()
        Get the Amount (component 5) as BigDecimal
        Returns:
        the Amount from component 5 converted to BigDecimal or null if cannot be converted
        Since:
        9.2.7

      • getAmountAsNumber

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

      • setComponent1

        public Field32K setComponent1​(java.lang.String component1)
        Set the component 1 (DayMonth).
        Parameters:
        component1 - the DayMonth to set
        Returns:
        the field object to enable build pattern

      • setDayMonth

        public Field32K setDayMonth​(java.lang.String component1)
        Set the DayMonth (component 1).
        Parameters:
        component1 - the DayMonth to set
        Returns:
        the field object to enable build pattern

      • setComponent2

        public Field32K setComponent2​(java.lang.String component2)
        Set the component 2 (Number Of Days/Months).
        Parameters:
        component2 - the Number Of Days/Months to set
        Returns:
        the field object to enable build pattern

      • setComponent2

        public Field32K setComponent2​(java.lang.Long component2)
        Set the component2 from a Long object.
        If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent2(String) method.
        Parameters:
        component2 - the Long with the Number Of Days/Months content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent2(String)

      • setComponent2

        public Field32K setComponent2​(java.lang.Number component2)
        Alternative method setter for field's Number Of Days/Months (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component2 - the Number with the Number Of Days/Months content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setNumberOfDaysMonths(java.lang.Long)

      • setNumberOfDaysMonths

        public Field32K setNumberOfDaysMonths​(java.lang.String component2)
        Set the Number Of Days/Months (component 2).
        Parameters:
        component2 - the Number Of Days/Months to set
        Returns:
        the field object to enable build pattern

      • setNumberOfDaysMonths

        public Field32K setNumberOfDaysMonths​(java.lang.Long component2)
        Set the Number Of Days/Months (component 2) from a Long object.
        Parameters:
        component2 - Long with the Number Of Days/Months content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent2(java.lang.Long)

      • setNumberOfDaysMonths

        public Field32K setNumberOfDaysMonths​(java.lang.Number component2)
        Alternative method setter for field's Number Of Days/Months (component 2) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component2 - the Number with the Number Of Days/Months content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setNumberOfDaysMonths(java.lang.Long)

      • setNumberofDaysMonths

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public Field32K setNumberofDaysMonths​(java.lang.String component2)
        Deprecated.
        use #setNumberOfDaysMonths(String) instead

      • setNumberofDaysMonths

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public Field32K setNumberofDaysMonths​(java.lang.Long component2)
        Deprecated.
        use #setComponent2(java.lang.Long) instead
        Since:
        9.2.7

      • setNumberofDaysMonths

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public Field32K setNumberofDaysMonths​(java.lang.Number component2)
        Deprecated.
        use #setNumberOfDaysMonths(java.lang.Long) instead

      • setComponent3

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

      • setCode

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

      • setComponent4

        public Field32K setComponent4​(java.lang.String component4)
        Set the component 4 (Currency).
        Parameters:
        component4 - the Currency to set
        Returns:
        the field object to enable build pattern

      • setComponent4

        public Field32K setComponent4​(java.util.Currency component4)
        Set the component4 from a Currency object.
        Parameters:
        component4 - the Currency with the Currency content to set
        Returns:
        the field object to enable build pattern

      • setCurrency

        public Field32K setCurrency​(java.lang.String component4)
        Set the Currency (component 4).
        Parameters:
        component4 - the Currency to set
        Returns:
        the field object to enable build pattern

      • setCurrency

        public Field32K setCurrency​(java.util.Currency component4)
        Set the Currency (component 4) from a Currency object.
        Parameters:
        component4 - Currency with the Currency content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent4(java.util.Currency)

      • setComponent5

        public Field32K setComponent5​(java.lang.String component5)
        Set the component 5 (Amount).
        Parameters:
        component5 - the Amount to set
        Returns:
        the field object to enable build pattern

      • setComponent5

        public Field32K setComponent5​(java.math.BigDecimal component5)
        Set the component5 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:
        component5 - the BigDecimal with the Amount content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7

      • setComponent5

        public Field32K setComponent5​(java.lang.Number component5)
        Alternative method setter for field's Amount (component 5) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
        Parameters:
        component5 - the Number with the Amount content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setAmount(java.math.BigDecimal)

      • setAmount

        public Field32K setAmount​(java.lang.String component5)
        Set the Amount (component 5).
        Parameters:
        component5 - the Amount to set
        Returns:
        the field object to enable build pattern

      • setAmount

        public Field32K setAmount​(java.math.BigDecimal component5)
        Set the Amount (component 5) from a BigDecimal object.
        Parameters:
        component5 - BigDecimal with the Amount content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent5(java.math.BigDecimal)

      • setAmount

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

      • currencyStrings

        public java.util.List<java.lang.String> currencyStrings()
        Description copied from interface: CurrencyContainer
        Get a list of strings of currencies present in this field
        Specified by:
        currencyStrings in interface CurrencyContainer
        Returns:
        found currency codes or empty list

      • currencyString

        public java.lang.String currencyString()
        Description copied from interface: CurrencyContainer
        Get the single currency contained in this field.
        Specified by:
        currencyString in interface CurrencyContainer
        Returns:
        null if no currency is contained - which should never happen, or throws an exception if more than one currency is present in this field.

      • initializeCurrencies

        public void initializeCurrencies​(java.lang.String cur)
        Description copied from interface: CurrencyContainer
        Set the currency of this field. If this field contains more than one currency then all currency components will be set. Individual setComponentNN should be used to set only one component of the field.
        Specified by:
        initializeCurrencies in interface CurrencyContainer

      • 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:
        MonetaryAmountResolver.amounts(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 Field32K.NAME

      • get

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