Package com.prowidesoftware.swift.model.field

Class Field11S

  • All Implemented Interfaces:
    JsonSerializable, DateContainer, MultiLineField, PatternContainer, java.io.Serializable
    @Generated
public class Field11S
extends Field
implements java.io.Serializable, DateContainer, MultiLineField
    SWIFT MT Field 11S.

    Model and parser for field 11S of a SWIFT MT message.

    Subfields (components) Data types

    1. Component 1: MTNumber: Long
    2. Component 2: Date: Calendar
    3. Component 3: SessionNumber: Long
    4. Component 4: ISN: Long

    Structure definition

    • validation pattern: <MT>$<DATE2>[$4!n6!n]
    • parser pattern: S$<DATE2>[$4!S6!S]
    • components pattern: MENN

    This class complies with standard release SRU2022

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

      • F_11S

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

      • MT_NUMBER

        public static final java.lang.Integer MT_NUMBER
        Component number for the MT Number subfield.

      • MT

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public static final java.lang.Integer MT
        Deprecated.
        Alternative (DEPRECATED) constant name for field's MT Number Component number.
        See Also:
        MT_NUMBER

      • DATE

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

      • SESSION_NUMBER

        public static final java.lang.Integer SESSION_NUMBER
        Component number for the Session Number subfield.

      • ISN

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

    • Constructor Detail

      • Field11S

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

      • Field11S

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

      • Field11S

        public Field11S​(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 Field11S newInstance​(Field11S 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 (MT Number).
        Returns:
        the component 1

      • getMTNumber

        public java.lang.String getMTNumber()
        Gets the MT Number (component 1).
        Returns:
        the MT Number from component 1

      • getComponent2

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

      • getComponent2AsCalendar

        public java.util.Calendar getComponent2AsCalendar()
        Get the component 2 as Calendar
        Returns:
        the component 2 converted to Calendar or null if cannot be converted

      • getDate

        public java.lang.String getDate()
        Gets the Date (component 2).
        Returns:
        the Date from component 2

      • getDateAsCalendar

        public java.util.Calendar getDateAsCalendar()
        Get the Date (component 2) as Calendar
        Returns:
        the Date from component 2 converted to Calendar or null if cannot be converted

      • getComponent3

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

      • getComponent3AsLong

        public java.lang.Long getComponent3AsLong()
        Get the component 3 as Long
        Returns:
        the component 3 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getComponent3AsNumber

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getComponent3AsNumber()
        Deprecated.
        Get the component 3 as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent3AsLong() to get the proper value.
        Returns:
        the component 3 converted to Number (BigDecimal) or null if cannot be converted
        See Also:
        getComponent3AsLong()

      • getSessionNumber

        public java.lang.String getSessionNumber()
        Gets the Session Number (component 3).
        Returns:
        the Session Number from component 3

      • getSessionNumberAsLong

        public java.lang.Long getSessionNumberAsLong()
        Get the Session Number (component 3) as Long
        Returns:
        the Session Number from component 3 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getSessionNumberAsNumber

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getSessionNumberAsNumber()
        Deprecated.
        Get the Session Number (component 3) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent3AsLong() to get the proper value.
        Returns:
        the component 3 converted to Number (BigDecimal) or null if cannot be converted
        See Also:
        getSessionNumberAsLong()

      • getComponent4

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

      • getComponent4AsLong

        public java.lang.Long getComponent4AsLong()
        Get the component 4 as Long
        Returns:
        the component 4 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getComponent4AsNumber

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getComponent4AsNumber()
        Deprecated.
        Get the component 4 as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent4AsLong() to get the proper value.
        Returns:
        the component 4 converted to Number (BigDecimal) or null if cannot be converted
        See Also:
        getComponent4AsLong()

      • getISN

        public java.lang.String getISN()
        Gets the ISN (component 4).
        Returns:
        the ISN from component 4

      • getISNAsLong

        public java.lang.Long getISNAsLong()
        Get the ISN (component 4) as Long
        Returns:
        the ISN from component 4 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getISNAsNumber

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getISNAsNumber()
        Deprecated.
        Get the ISN (component 4) as as Number (BigDecimal) The value is returned as BigDecimal to keep compatibility with previous API. You should use getComponent4AsLong() to get the proper value.
        Returns:
        the component 4 converted to Number (BigDecimal) or null if cannot be converted
        See Also:
        getISNAsLong()

      • setComponent1

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

      • setMTNumber

        public Field11S setMTNumber​(java.lang.String component1)
        Set the MT Number (component 1).
        Parameters:
        component1 - the MT Number to set
        Returns:
        the field object to enable build pattern

      • setMT

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public Field11S setMT​(java.lang.String component1)
        Deprecated.
        Alternative DEPRECATED method setter for field's MT Number
        Parameters:
        component1 - the MT Number to set
        Returns:
        the field object to enable build pattern
        See Also:
        setMTNumber(String)

      • setComponent2

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

      • setComponent2

        public Field11S setComponent2​(java.util.Calendar component2)
        Set the component2 from a Calendar object.
        Parameters:
        component2 - the Calendar with the Date content to set
        Returns:
        the field object to enable build pattern

      • setDate

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

      • setDate

        public Field11S setDate​(java.util.Calendar component2)
        Set the Date (component 2) from a Calendar object.
        Parameters:
        component2 - Calendar with the Date content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent2(java.util.Calendar)

      • setComponent3

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

      • setComponent3

        public Field11S setComponent3​(java.lang.Long component3)
        Set the component3 from a Long object.
        If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent3(String) method.
        Parameters:
        component3 - the Long with the Session Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent3(String)

      • setComponent3

        public Field11S setComponent3​(java.lang.Number component3)
        Alternative method setter for field's Session Number (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component3 - the Number with the Session Number content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setSessionNumber(java.lang.Long)

      • setSessionNumber

        public Field11S setSessionNumber​(java.lang.String component3)
        Set the Session Number (component 3).
        Parameters:
        component3 - the Session Number to set
        Returns:
        the field object to enable build pattern

      • setSessionNumber

        public Field11S setSessionNumber​(java.lang.Long component3)
        Set the Session Number (component 3) from a Long object.
        Parameters:
        component3 - Long with the Session Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent3(java.lang.Long)

      • setSessionNumber

        public Field11S setSessionNumber​(java.lang.Number component3)
        Alternative method setter for field's Session Number (component 3) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component3 - the Number with the Session Number content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setSessionNumber(java.lang.Long)

      • setComponent4

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

      • setComponent4

        public Field11S setComponent4​(java.lang.Long component4)
        Set the component4 from a Long object.
        If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent4(String) method.
        Parameters:
        component4 - the Long with the ISN content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent4(String)

      • setComponent4

        public Field11S setComponent4​(java.lang.Number component4)
        Alternative method setter for field's ISN (component 4) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component4 - the Number with the ISN content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setISN(java.lang.Long)

      • setISN

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

      • setISN

        public Field11S setISN​(java.lang.Long component4)
        Set the ISN (component 4) from a Long object.
        Parameters:
        component4 - Long with the ISN content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent4(java.lang.Long)

      • setISN

        public Field11S setISN​(java.lang.Number component4)
        Alternative method setter for field's ISN (component 4) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
        Parameters:
        component4 - the Number with the ISN content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setISN(java.lang.Long)

      • dates

        public java.util.List<java.util.Calendar> dates()
        Returns all components that can be converted to a Calendar
        Specified by:
        dates in interface DateContainer
        Returns:
        the list of converted components (a Calendar object or null)

      • date

        public java.util.Calendar date()
        Returns the first component that can be converted to a Calendar
        Returns:
        the converted components (a Calendar object or null)

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

      • get

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