Package com.prowidesoftware.swift.model.field

Class Field345

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

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

    Subfields (components) Data types

    1. Component 1: MT1: Long
    2. Component 2: MT2: Long
    3. Component 3: MT3: Long
    4. Component 4: MT4: Long
    5. Component 5: MT5: Long
    6. Component 6: MT6: Long
    7. Component 7: MT7: Long
    8. Component 8: MT8: Long
    9. Component 9: MT9: Long
    10. Component 10: MT10: Long

    Structure definition

    • validation pattern: [3!c]*10
    • parser pattern: 3!S*10
    • components pattern: MMMMMMMMMM

    This class complies with standard release SRU2024

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

      • F_345

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

      • MT1

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

      • MT2

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

      • MT3

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

      • MT4

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

      • MT5

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

      • MT6

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

      • MT7

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

      • MT8

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

      • MT9

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

      • MT10

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

    • Constructor Detail

      • Field345

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

      • Field345

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

      • Field345

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

      • getMT1

        public java.lang.String getMT1()
        Gets the MT1 (component 1).
        Returns:
        the MT1 from component 1

      • getComponent2

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

      • getMT2

        public java.lang.String getMT2()
        Gets the MT2 (component 2).
        Returns:
        the MT2 from component 2

      • getComponent3

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

      • getMT3

        public java.lang.String getMT3()
        Gets the MT3 (component 3).
        Returns:
        the MT3 from component 3

      • getComponent4

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

      • getMT4

        public java.lang.String getMT4()
        Gets the MT4 (component 4).
        Returns:
        the MT4 from component 4

      • getComponent5

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

      • getMT5

        public java.lang.String getMT5()
        Gets the MT5 (component 5).
        Returns:
        the MT5 from component 5

      • getComponent6

        public java.lang.String getComponent6()
        Gets the component 6 (MT6).
        Returns:
        the component 6

      • getMT6

        public java.lang.String getMT6()
        Gets the MT6 (component 6).
        Returns:
        the MT6 from component 6

      • getComponent7

        public java.lang.String getComponent7()
        Gets the component 7 (MT7).
        Returns:
        the component 7

      • getMT7

        public java.lang.String getMT7()
        Gets the MT7 (component 7).
        Returns:
        the MT7 from component 7

      • getComponent8

        public java.lang.String getComponent8()
        Gets the component 8 (MT8).
        Returns:
        the component 8

      • getMT8

        public java.lang.String getMT8()
        Gets the MT8 (component 8).
        Returns:
        the MT8 from component 8

      • getComponent9

        public java.lang.String getComponent9()
        Gets the component 9 (MT9).
        Returns:
        the component 9

      • getMT9

        public java.lang.String getMT9()
        Gets the MT9 (component 9).
        Returns:
        the MT9 from component 9

      • getComponent10

        public java.lang.String getComponent10()
        Gets the component 10 (MT10).
        Returns:
        the component 10

      • getMT10

        public java.lang.String getMT10()
        Gets the MT10 (component 10).
        Returns:
        the MT10 from component 10

      • setComponent1

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

      • setMT1

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

      • setComponent2

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

      • setMT2

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

      • setComponent3

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

      • setMT3

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

      • setComponent4

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

      • setMT4

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

      • setComponent5

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

      • setMT5

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

      • setComponent6

        public Field345 setComponent6​(java.lang.String component6)
        Set the component 6 (MT6).
        Parameters:
        component6 - the MT6 to set
        Returns:
        the field object to enable build pattern

      • setMT6

        public Field345 setMT6​(java.lang.String component6)
        Set the MT6 (component 6).
        Parameters:
        component6 - the MT6 to set
        Returns:
        the field object to enable build pattern

      • setComponent7

        public Field345 setComponent7​(java.lang.String component7)
        Set the component 7 (MT7).
        Parameters:
        component7 - the MT7 to set
        Returns:
        the field object to enable build pattern

      • setMT7

        public Field345 setMT7​(java.lang.String component7)
        Set the MT7 (component 7).
        Parameters:
        component7 - the MT7 to set
        Returns:
        the field object to enable build pattern

      • setComponent8

        public Field345 setComponent8​(java.lang.String component8)
        Set the component 8 (MT8).
        Parameters:
        component8 - the MT8 to set
        Returns:
        the field object to enable build pattern

      • setMT8

        public Field345 setMT8​(java.lang.String component8)
        Set the MT8 (component 8).
        Parameters:
        component8 - the MT8 to set
        Returns:
        the field object to enable build pattern

      • setComponent9

        public Field345 setComponent9​(java.lang.String component9)
        Set the component 9 (MT9).
        Parameters:
        component9 - the MT9 to set
        Returns:
        the field object to enable build pattern

      • setMT9

        public Field345 setMT9​(java.lang.String component9)
        Set the MT9 (component 9).
        Parameters:
        component9 - the MT9 to set
        Returns:
        the field object to enable build pattern

      • setComponent10

        public Field345 setComponent10​(java.lang.String component10)
        Set the component 10 (MT10).
        Parameters:
        component10 - the MT10 to set
        Returns:
        the field object to enable build pattern

      • setMT10

        public Field345 setMT10​(java.lang.String component10)
        Set the MT10 (component 10).
        Parameters:
        component10 - the MT10 to set
        Returns:
        the field object to enable build pattern

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

      • get

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