Package com.prowidesoftware.swift.model.field

Class Field92L

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

      • F_92L

        public static final java.lang.String F_92L
        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.

      • FIRST_CURRENCY_CODE

        public static final java.lang.Integer FIRST_CURRENCY_CODE
        Component number for the First Currency Code subfield.

      • AMOUNT1

        public static final java.lang.Integer AMOUNT1
        Component number for the Amount1 subfield.

      • SECOND_CURRENCY_CODE

        public static final java.lang.Integer SECOND_CURRENCY_CODE
        Component number for the Second Currency Code subfield.

      • AMOUNT2

        public static final java.lang.Integer AMOUNT2
        Component number for the Amount2 subfield.

      • CONDITIONAL_QUALIFIER

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

    • Constructor Detail

      • Field92L

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

      • Field92L

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

      • Field92L

        public Field92L​(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 Field92L newInstance​(Field92L 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 (First Currency Code).
        Returns:
        the component 2

      • getComponent2AsCurrency

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

      • getFirstCurrencyCode

        public java.lang.String getFirstCurrencyCode()
        Gets the First Currency Code (component 2).
        Returns:
        the First Currency Code from component 2

      • getCurrency1

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.String getCurrency1()
        Deprecated.
        use #getFirstCurrencyCode() instead
        Alternative DEPRECATED method getter for field's First Currency Code
        Since:
        9.2.7

      • getFirstCurrencyCodeAsCurrency

        public java.util.Currency getFirstCurrencyCodeAsCurrency()
        Get the First Currency Code (component 2) as Currency
        Returns:
        the First Currency Code from component 2 converted to Currency or null if cannot be converted

      • getCurrency1AsCurrency

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.util.Currency getCurrency1AsCurrency()
        Deprecated.
        use #getFirstCurrencyCodeAsCurrency() instead

      • getComponent3

        public java.lang.String getComponent3()
        Gets the component 3 (Amount1).
        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

      • getAmount1

        public java.lang.String getAmount1()
        Gets the Amount1 (component 3).
        Returns:
        the Amount1 from component 3

      • getAmount1AsBigDecimal

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

      • getAmount1AsNumber

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

      • getComponent4

        public java.lang.String getComponent4()
        Gets the component 4 (Second Currency Code).
        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

      • getSecondCurrencyCode

        public java.lang.String getSecondCurrencyCode()
        Gets the Second Currency Code (component 4).
        Returns:
        the Second Currency Code from component 4

      • getCurrency2

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.String getCurrency2()
        Deprecated.
        use #getSecondCurrencyCode() instead
        Alternative DEPRECATED method getter for field's Second Currency Code
        Since:
        9.2.7

      • getSecondCurrencyCodeAsCurrency

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

      • getCurrency2AsCurrency

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.util.Currency getCurrency2AsCurrency()
        Deprecated.
        use #getSecondCurrencyCodeAsCurrency() instead

      • getComponent5

        public java.lang.String getComponent5()
        Gets the component 5 (Amount2).
        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

      • getAmount2

        public java.lang.String getAmount2()
        Gets the Amount2 (component 5).
        Returns:
        the Amount2 from component 5

      • getAmount2AsBigDecimal

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

      • getAmount2AsNumber

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

      • setComponent1

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

      • setComponent2

        public Field92L setComponent2​(java.util.Currency component2)
        Set the component2 from a Currency object.
        Parameters:
        component2 - the Currency with the First Currency Code content to set
        Returns:
        the field object to enable build pattern

      • setFirstCurrencyCode

        public Field92L setFirstCurrencyCode​(java.lang.String component2)
        Set the First Currency Code (component 2).
        Parameters:
        component2 - the First Currency Code to set
        Returns:
        the field object to enable build pattern

      • setFirstCurrencyCode

        public Field92L setFirstCurrencyCode​(java.util.Currency component2)
        Set the First Currency Code (component 2) from a Currency object.
        Parameters:
        component2 - Currency with the First Currency Code content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent2(java.util.Currency)

      • setComponent3

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

      • setComponent3

        public Field92L 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 Amount1 content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7

      • setComponent3

        public Field92L setComponent3​(java.lang.Number component3)
        Alternative method setter for field's Amount1 (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 Amount1 content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setAmount1(java.math.BigDecimal)

      • setAmount1

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

      • setAmount1

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

      • setAmount1

        public Field92L setAmount1​(java.lang.Number component3)
        Alternative method setter for field's Amount1 (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 Amount1 content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setAmount1(java.math.BigDecimal)

      • setComponent4

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

      • setComponent4

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

      • setSecondCurrencyCode

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

      • setSecondCurrencyCode

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

      • setComponent5

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

      • setComponent5

        public Field92L 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 Amount2 content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7

      • setComponent5

        public Field92L setComponent5​(java.lang.Number component5)
        Alternative method setter for field's Amount2 (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 Amount2 content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setAmount2(java.math.BigDecimal)

      • setAmount2

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

      • setAmount2

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

      • setAmount2

        public Field92L setAmount2​(java.lang.Number component5)
        Alternative method setter for field's Amount2 (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 Amount2 content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setAmount2(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)

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

      • get

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