Package com.prowidesoftware.swift.model.field

Class Field347

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

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

    Subfields (components) Data types

    1. Component 1: Field1: String
    2. Component 2: Field2: String
    3. Component 3: Field3: String
    4. Component 4: Field4: String
    5. Component 5: Field5: String
    6. Component 6: Field6: String
    7. Component 7: Field7: String
    8. Component 8: Field8: String
    9. Component 9: Field9: String
    10. Component 10: Field10: String

    Structure definition

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

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

      • F_347

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

      • FIELD_1

        public static final java.lang.Integer FIELD_1
        Component number for the Field 1 subfield.

      • FIELD_2

        public static final java.lang.Integer FIELD_2
        Component number for the Field 2 subfield.

      • FIELD_3

        public static final java.lang.Integer FIELD_3
        Component number for the Field 3 subfield.

      • FIELD_4

        public static final java.lang.Integer FIELD_4
        Component number for the Field 4 subfield.

      • FIELD_5

        public static final java.lang.Integer FIELD_5
        Component number for the Field 5 subfield.

      • FIELD_6

        public static final java.lang.Integer FIELD_6
        Component number for the Field 6 subfield.

      • FIELD_7

        public static final java.lang.Integer FIELD_7
        Component number for the Field 7 subfield.

      • FIELD_8

        public static final java.lang.Integer FIELD_8
        Component number for the Field 8 subfield.

      • FIELD_9

        public static final java.lang.Integer FIELD_9
        Component number for the Field 9 subfield.

      • FIELD_10

        public static final java.lang.Integer FIELD_10
        Component number for the Field 10 subfield.

    • Constructor Detail

      • Field347

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

      • Field347

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

      • Field347

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

      • getField1

        public java.lang.String getField1()
        Gets the Field 1 (component 1).
        Returns:
        the Field 1 from component 1

      • getComponent2

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

      • getField2

        public java.lang.String getField2()
        Gets the Field 2 (component 2).
        Returns:
        the Field 2 from component 2

      • getComponent3

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

      • getField3

        public java.lang.String getField3()
        Gets the Field 3 (component 3).
        Returns:
        the Field 3 from component 3

      • getComponent4

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

      • getField4

        public java.lang.String getField4()
        Gets the Field 4 (component 4).
        Returns:
        the Field 4 from component 4

      • getComponent5

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

      • getField5

        public java.lang.String getField5()
        Gets the Field 5 (component 5).
        Returns:
        the Field 5 from component 5

      • getComponent6

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

      • getField6

        public java.lang.String getField6()
        Gets the Field 6 (component 6).
        Returns:
        the Field 6 from component 6

      • getComponent7

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

      • getField7

        public java.lang.String getField7()
        Gets the Field 7 (component 7).
        Returns:
        the Field 7 from component 7

      • getComponent8

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

      • getField8

        public java.lang.String getField8()
        Gets the Field 8 (component 8).
        Returns:
        the Field 8 from component 8

      • getComponent9

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

      • getField9

        public java.lang.String getField9()
        Gets the Field 9 (component 9).
        Returns:
        the Field 9 from component 9

      • getComponent10

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

      • getField10

        public java.lang.String getField10()
        Gets the Field 10 (component 10).
        Returns:
        the Field 10 from component 10

      • setComponent1

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

      • setField1

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

      • setComponent2

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

      • setField2

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

      • setComponent3

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

      • setField3

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

      • setComponent4

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

      • setField4

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

      • setComponent5

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

      • setField5

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

      • setComponent6

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

      • setField6

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

      • setComponent7

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

      • setField7

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

      • setComponent8

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

      • setField8

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

      • setComponent9

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

      • setField9

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

      • setComponent10

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

      • setField10

        public Field347 setField10​(java.lang.String component10)
        Set the Field 10 (component 10).
        Parameters:
        component10 - the Field 10 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 Field347.NAME

      • get

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