Package com.prowidesoftware.swift.model.field

Class Field346

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

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

    Subfields (components) Data types

    1. Component 1: Branch1: String
    2. Component 2: Branch2: String
    3. Component 3: Branch3: String
    4. Component 4: Branch4: String
    5. Component 5: Branch5: String
    6. Component 6: Branch6: String
    7. Component 7: Branch7: String
    8. Component 8: Branch8: String
    9. Component 9: Branch9: String
    10. Component 10: Branch10: 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 346.
        See Also:
        Constant Field Values

      • F_346

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

      • BRANCH1

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

      • BRANCH2

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

      • BRANCH3

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

      • BRANCH4

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

      • BRANCH5

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

      • BRANCH6

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

      • BRANCH7

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

      • BRANCH8

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

      • BRANCH9

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

      • BRANCH10

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

    • Constructor Detail

      • Field346

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

      • Field346

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

      • Field346

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

      • getBranch1

        public java.lang.String getBranch1()
        Gets the Branch1 (component 1).
        Returns:
        the Branch1 from component 1

      • getComponent2

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

      • getBranch2

        public java.lang.String getBranch2()
        Gets the Branch2 (component 2).
        Returns:
        the Branch2 from component 2

      • getComponent3

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

      • getBranch3

        public java.lang.String getBranch3()
        Gets the Branch3 (component 3).
        Returns:
        the Branch3 from component 3

      • getComponent4

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

      • getBranch4

        public java.lang.String getBranch4()
        Gets the Branch4 (component 4).
        Returns:
        the Branch4 from component 4

      • getComponent5

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

      • getBranch5

        public java.lang.String getBranch5()
        Gets the Branch5 (component 5).
        Returns:
        the Branch5 from component 5

      • getComponent6

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

      • getBranch6

        public java.lang.String getBranch6()
        Gets the Branch6 (component 6).
        Returns:
        the Branch6 from component 6

      • getComponent7

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

      • getBranch7

        public java.lang.String getBranch7()
        Gets the Branch7 (component 7).
        Returns:
        the Branch7 from component 7

      • getComponent8

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

      • getBranch8

        public java.lang.String getBranch8()
        Gets the Branch8 (component 8).
        Returns:
        the Branch8 from component 8

      • getComponent9

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

      • getBranch9

        public java.lang.String getBranch9()
        Gets the Branch9 (component 9).
        Returns:
        the Branch9 from component 9

      • getComponent10

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

      • getBranch10

        public java.lang.String getBranch10()
        Gets the Branch10 (component 10).
        Returns:
        the Branch10 from component 10

      • setComponent1

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

      • setBranch1

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

      • setComponent2

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

      • setBranch2

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

      • setComponent3

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

      • setBranch3

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

      • setComponent4

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

      • setBranch4

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

      • setComponent5

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

      • setBranch5

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

      • setComponent6

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

      • setBranch6

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

      • setComponent7

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

      • setBranch7

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

      • setComponent8

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

      • setBranch8

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

      • setComponent9

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

      • setBranch9

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

      • setComponent10

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

      • setBranch10

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

      • get

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