Package com.prowidesoftware.swift.model.field

Class Field35B

  • All Implemented Interfaces:
    JsonSerializable, MultiLineField, PatternContainer, java.io.Serializable
    @Generated
public class Field35B
extends Field
implements java.io.Serializable, MultiLineField
    SWIFT MT Field 35B.

    Model and parser for field 35B of a SWIFT MT message.

    Subfields (components) Data types

    1. Component 1: Qualifier: String
    2. Component 2: ISIN: String
    3. Component 3: Description: String
    4. Component 4: Description2: String
    5. Component 5: Description3: String
    6. Component 6: Description4: String

    Structure definition

    • validation pattern: [<ISIN> 12!c][$][35x][$35x]0-3(****)
    • parser pattern: [<ISIN><SPACE>S][$S]0-4
    • components pattern: SSSSSS

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

      • F_35B

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

      • ISIN

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

      • IDENTIFICATION_OF_INSTRUMENT

        public static final java.lang.Integer IDENTIFICATION_OF_INSTRUMENT
        Alternative constant name for field's ISIN Component number.
        See Also:
        ISIN

      • IDENTIFICATION_OF_SECURITY

        public static final java.lang.Integer IDENTIFICATION_OF_SECURITY
        Alternative constant name for field's ISIN Component number.
        See Also:
        ISIN

      • DESCRIPTION

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

      • DESCRIPTION_OF_INSTRUMENT

        public static final java.lang.Integer DESCRIPTION_OF_INSTRUMENT
        Alternative constant name for field's Description Component number.
        See Also:
        DESCRIPTION

      • DESCRIPTION_OF_SECURITY

        public static final java.lang.Integer DESCRIPTION_OF_SECURITY
        Alternative constant name for field's Description Component number.
        See Also:
        DESCRIPTION

    • Constructor Detail

      • Field35B

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

      • Field35B

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

      • Field35B

        public Field35B​(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 Field35B newInstance​(Field35B 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 (ISIN).
        Returns:
        the component 2

      • getISIN

        public java.lang.String getISIN()
        Gets the ISIN (component 2).
        Returns:
        the ISIN from component 2

      • getIdentificationOfInstrument

        public java.lang.String getIdentificationOfInstrument()
        Alternative method getter for field's ISIN
        Since:
        9.2.7

      • getIdentificationOfSecurity

        public java.lang.String getIdentificationOfSecurity()
        Alternative method getter for field's ISIN
        Since:
        9.2.7

      • getComponent3

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

      • getDescriptionLine1

        public java.lang.String getDescriptionLine1()
        Gets the Description (component 3).
        Returns:
        the Description from component 3

      • getDescriptionOfInstrumentLine1

        public java.lang.String getDescriptionOfInstrumentLine1()
        Alternative method getter for field's Description
        Since:
        9.2.7

      • getDescriptionOfSecurityLine1

        public java.lang.String getDescriptionOfSecurityLine1()
        Alternative method getter for field's Description
        Since:
        9.2.7

      • getDescription

        public java.lang.String getDescription()
        Gets the Description as a concatenation of component 3 to component 6.
        Returns:
        the Description from components

      • getDescription

        public java.lang.String getDescription​(java.lang.CharSequence deli)
        Gets the Description as a concatenation of component 3 to component 6 joined together with a copy of the specified delimiter.
        Parameters:
        deli - the delimiter that separates each component
        Returns:
        the Description from components
        Since:
        9.1.4

      • getDescriptionOfInstrument

        public java.lang.String getDescriptionOfInstrument()

      • getDescriptionOfInstrument

        public java.lang.String getDescriptionOfInstrument​(java.lang.CharSequence deli)

      • getDescriptionOfSecurity

        public java.lang.String getDescriptionOfSecurity()

      • getDescriptionOfSecurity

        public java.lang.String getDescriptionOfSecurity​(java.lang.CharSequence deli)

      • getComponent4

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

      • getDescriptionLine2

        public java.lang.String getDescriptionLine2()
        Gets the Description 2 (component 4).
        Returns:
        the Description 2 from component 4

      • getDescriptionOfInstrumentLine2

        public java.lang.String getDescriptionOfInstrumentLine2()
        Alternative method getter for field's Description 2
        Since:
        9.2.7

      • getDescriptionOfSecurityLine2

        public java.lang.String getDescriptionOfSecurityLine2()
        Alternative method getter for field's Description 2
        Since:
        9.2.7

      • getComponent5

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

      • getDescriptionLine3

        public java.lang.String getDescriptionLine3()
        Gets the Description 3 (component 5).
        Returns:
        the Description 3 from component 5

      • getDescriptionOfInstrumentLine3

        public java.lang.String getDescriptionOfInstrumentLine3()
        Alternative method getter for field's Description 3
        Since:
        9.2.7

      • getDescriptionOfSecurityLine3

        public java.lang.String getDescriptionOfSecurityLine3()
        Alternative method getter for field's Description 3
        Since:
        9.2.7

      • getComponent6

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

      • getDescriptionLine4

        public java.lang.String getDescriptionLine4()
        Gets the Description 4 (component 6).
        Returns:
        the Description 4 from component 6

      • getDescriptionOfInstrumentLine4

        public java.lang.String getDescriptionOfInstrumentLine4()
        Alternative method getter for field's Description 4
        Since:
        9.2.7

      • getDescriptionOfSecurityLine4

        public java.lang.String getDescriptionOfSecurityLine4()
        Alternative method getter for field's Description 4
        Since:
        9.2.7

      • setComponent1

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

      • setISIN

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

      • setIdentificationOfInstrument

        public Field35B setIdentificationOfInstrument​(java.lang.String component2)

      • setIdentificationOfSecurity

        public Field35B setIdentificationOfSecurity​(java.lang.String component2)

      • setComponent3

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

      • setDescriptionLine1

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

      • setDescriptionOfInstrumentLine1

        public Field35B setDescriptionOfInstrumentLine1​(java.lang.String component3)

      • setDescriptionOfSecurityLine1

        public Field35B setDescriptionOfSecurityLine1​(java.lang.String component3)

      • setDescription

        public Field35B setDescription​(java.lang.String value)
        Set the Description splitting the parameter lines into components 3 to 6.
        Parameters:
        value - the Description to set, may contain line ends and each line will be set to its correspondent component attribute
        Returns:
        the field object to enable build pattern

      • setDescriptionOfInstrument

        public Field35B setDescriptionOfInstrument​(java.lang.String value)

      • setDescriptionOfSecurity

        public Field35B setDescriptionOfSecurity​(java.lang.String value)

      • setComponent4

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

      • setDescriptionLine2

        public Field35B setDescriptionLine2​(java.lang.String component4)
        Set the Description 2 (component 4).
        Parameters:
        component4 - the Description 2 to set
        Returns:
        the field object to enable build pattern

      • setDescriptionOfInstrumentLine2

        public Field35B setDescriptionOfInstrumentLine2​(java.lang.String component4)

      • setDescriptionOfSecurityLine2

        public Field35B setDescriptionOfSecurityLine2​(java.lang.String component4)

      • setComponent5

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

      • setDescriptionLine3

        public Field35B setDescriptionLine3​(java.lang.String component5)
        Set the Description 3 (component 5).
        Parameters:
        component5 - the Description 3 to set
        Returns:
        the field object to enable build pattern

      • setDescriptionOfInstrumentLine3

        public Field35B setDescriptionOfInstrumentLine3​(java.lang.String component5)

      • setDescriptionOfSecurityLine3

        public Field35B setDescriptionOfSecurityLine3​(java.lang.String component5)

      • setComponent6

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

      • setDescriptionLine4

        public Field35B setDescriptionLine4​(java.lang.String component6)
        Set the Description 4 (component 6).
        Parameters:
        component6 - the Description 4 to set
        Returns:
        the field object to enable build pattern

      • setDescriptionOfInstrumentLine4

        public Field35B setDescriptionOfInstrumentLine4​(java.lang.String component6)

      • setDescriptionOfSecurityLine4

        public Field35B setDescriptionOfSecurityLine4​(java.lang.String component6)

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

      • get

        public static Field35B 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 Field35B get​(SwiftMessage msg)
        Gets the first instance of Field35B 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<Field35B> getAll​(SwiftMessage msg)
        Gets a list of all occurrences of the field Field35B 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<Field35B> getAll​(SwiftTagListBlock block)
        Gets a list of all occurrences of the field Field35B 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

      • getLine

        public java.lang.String getLine​(int line)
        Returns a specific line from the field's value.
        Specified by:
        getLine in interface MultiLineField
        Parameters:
        line - a reference to a specific line in the field, first line being 1
        Returns:
        line content or null if not present or if line number is above the expected
        Since:
        7.7
        See Also:
        MultiLineField.getLine(int)

      • getLine

        public java.lang.String getLine​(int line,
                                int offset)
        Returns a specific line from the field's value.
        Specified by:
        getLine in interface MultiLineField
        Parameters:
        line - a reference to a specific line in the field, first line being 1
        offset - an optional component number used as offset when counting lines
        Returns:
        line content or null if not present or if line number is above the expected
        Since:
        7.7
        See Also:
        MultiLineField.getLine(int, int)

      • getLines

        public java.util.List<java.lang.String> getLines()
        Returns the field value split into lines.
        Specified by:
        getLines in interface MultiLineField
        Returns:
        lines content or empty list if field's value is empty
        Since:
        7.7
        See Also:
        MultiLineField.getLines()

      • getLines

        public java.util.List<java.lang.String> getLines​(int offset)
        Returns the field value starting at the offset component, split into lines.
        Specified by:
        getLines in interface MultiLineField
        Parameters:
        offset - an optional component number used as offset when counting lines
        Returns:
        found lines or empty list if lines are not present or the offset is invalid
        Since:
        7.7
        See Also:
        MultiLineField.getLines(int)

      • getLinesBetween

        public java.util.List<java.lang.String> getLinesBetween​(int start,
                                                        int end)
        Returns a specific subset of lines from the field's value, given a range.
        Specified by:
        getLinesBetween in interface MultiLineField
        Parameters:
        start - a reference to a specific line in the field, first line being 1
        end - a reference to a specific line in the field, must be greater than start
        Returns:
        found lines or empty list if value is empty
        Since:
        7.7
        See Also:
        MultiLineField.getLinesBetween(int, int )

      • getLinesBetween

        public java.util.List<java.lang.String> getLinesBetween​(int start,
                                                        int end,
                                                        int offset)
        Returns a specific subset of lines from the field's value, starting at the offset component.
        Specified by:
        getLinesBetween in interface MultiLineField
        Parameters:
        start - a reference to a specific line in the field, first line being 1
        end - a reference to a specific line in the field, must be greater than start
        offset - an optional component number used as offset when counting lines
        Returns:
        found lines or empty list if lines are not present or the offset is invalid
        Since:
        7.7
        See Also:
        MultiLineField.getLinesBetween(int start, int end, int offset)

      • fromJson

        public static Field35B fromJson​(java.lang.String json)
        This method deserializes the JSON data into a Field35B 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)