Package com.prowidesoftware.swift.model.field

Class Field23

  • All Implemented Interfaces:
    JsonSerializable, CurrencyContainer, PatternContainer, java.io.Serializable
    @Generated
public class Field23
extends Field
implements java.io.Serializable, CurrencyContainer
    SWIFT MT Field 23.

    Model and parser for field 23 of a SWIFT MT message.

    Subfields (components) Data types

    1. Component 1: Code1: String
    2. Component 2: Code2: String
    3. Component 3: Code3: String
    4. Component 4: Currency: Currency

    Structure definition

    • validation pattern: CUSTOM
    • parser pattern: S[/S/S[/S]]
    • components pattern: SSSC

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

      • F_23

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

      • CODE_1

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

      • BUY_SELL_INDICATOR

        public static final java.lang.Integer BUY_SELL_INDICATOR
        Alternative constant name for field's Code 1 Component number.
        See Also:
        CODE_1

      • CODE_2

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

      • CALL_PUT_INDICATOR

        public static final java.lang.Integer CALL_PUT_INDICATOR
        Alternative constant name for field's Code 2 Component number.
        See Also:
        CODE_2

      • CODE_3

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

      • STYLE_INDICATOR

        public static final java.lang.Integer STYLE_INDICATOR
        Alternative constant name for field's Code 3 Component number.
        See Also:
        CODE_3

      • CURRENCY

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

      • MANUAL_AUTOMATIC_INDICATOR

        public static final java.lang.Integer MANUAL_AUTOMATIC_INDICATOR
        Alternative constant name for field's Currency Component number.
        See Also:
        CURRENCY

    • Constructor Detail

      • Field23

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

      • Field23

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

      • Field23

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

      • getCode1

        public java.lang.String getCode1()
        Gets the Code 1 (component 1).
        Returns:
        the Code 1 from component 1

      • getBuySellIndicator

        public java.lang.String getBuySellIndicator()
        Deprecated.
        use #getCode1() instead
        Alternative method getter for field's Code 1
        Since:
        9.2.7

      • getComponent2

        public java.lang.String getComponent2()
        Gets the component 2 (Code 2).
        Returns:
        the component 2

      • getCode2

        public java.lang.String getCode2()
        Gets the Code 2 (component 2).
        Returns:
        the Code 2 from component 2

      • getCallPutIndicator

        public java.lang.String getCallPutIndicator()
        Deprecated.
        use #getCode2() instead
        Alternative method getter for field's Code 2
        Since:
        9.2.7

      • getComponent3

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

      • getCode3

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

      • getStyleIndicator

        public java.lang.String getStyleIndicator()
        Deprecated.
        use #getCode3() instead
        Alternative method getter for field's Code 3
        Since:
        9.2.7

      • 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

      • getManualAutomaticIndicator

        public java.lang.String getManualAutomaticIndicator()
        Deprecated.
        use #getCurrency() instead
        Alternative method getter for field's Currency
        Since:
        9.2.7

      • 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

      • getManualAutomaticIndicatorAsCurrency

        public java.util.Currency getManualAutomaticIndicatorAsCurrency()
        Deprecated.
        use #getCurrencyAsCurrency() instead
        Since:
        9.2.7

      • setComponent1

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

      • setCode1

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

      • setBuySellIndicator

        public Field23 setBuySellIndicator​(java.lang.String component1)
        Deprecated.
        use #setCode1(String) instead

      • setComponent2

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

      • setCode2

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

      • setCallPutIndicator

        public Field23 setCallPutIndicator​(java.lang.String component2)
        Deprecated.
        use #setCode2(String) instead

      • setComponent3

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

      • setCode3

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

      • setStyleIndicator

        public Field23 setStyleIndicator​(java.lang.String component3)
        Deprecated.
        use #setCode3(String) instead

      • setComponent4

        public Field23 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 Field23 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 Field23 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 Field23 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)

      • setManualAutomaticIndicator

        public Field23 setManualAutomaticIndicator​(java.lang.String component4)
        Deprecated.
        use #setCurrency(String) instead

      • setManualAutomaticIndicator

        public Field23 setManualAutomaticIndicator​(java.util.Currency component4)
        Deprecated.
        use #setComponent4(java.util.Currency) instead

      • 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

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

      • get

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