Package com.prowidesoftware.swift.model.field

Class Field330

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

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

    Subfields (components) Data types

    1. Component 1: SessionNumber: Long
    2. Component 2: ISN: Long
    3. Component 3: ISNNAK: Long
    4. Component 4: OSN: Long
    5. Component 5: OSNNAK: Long
    6. Component 6: ACKReplayIndicator: Long

    Structure definition

    • validation pattern: 4!n6!n6!n6!n6!n1!n
    • parser pattern: 4!N6!N6!N6!N6!N1!N
    • components pattern: NNNNNN

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

      • F_330

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

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

      • ISN_NAK

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

      • OSN

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

      • OSN_NAK

        public static final java.lang.Integer OSN_NAK
        Component number for the OSN NAK subfield.

      • ACK_REPLAY_INDICATOR

        public static final java.lang.Integer ACK_REPLAY_INDICATOR
        Component number for the ACK Replay Indicator subfield.

    • Constructor Detail

      • Field330

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

      • Field330

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

      • Field330

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

      • getComponent1AsLong

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

      • getSessionNumber

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

      • getSessionNumberAsLong

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

      • getComponent2

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

      • getComponent2AsLong

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

      • getISN

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

      • getISNAsLong

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

      • getComponent3

        public java.lang.String getComponent3()
        Gets the component 3 (ISN NAK).
        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

      • getISNNAK

        public java.lang.String getISNNAK()
        Gets the ISN NAK (component 3).
        Returns:
        the ISN NAK from component 3

      • getISNNAKAsLong

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

      • getComponent4

        public java.lang.String getComponent4()
        Gets the component 4 (OSN).
        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

      • getOSN

        public java.lang.String getOSN()
        Gets the OSN (component 4).
        Returns:
        the OSN from component 4

      • getOSNAsLong

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

      • getComponent5

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

      • getComponent5AsLong

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

      • getOSNNAK

        public java.lang.String getOSNNAK()
        Gets the OSN NAK (component 5).
        Returns:
        the OSN NAK from component 5

      • getOSNNAKAsLong

        public java.lang.Long getOSNNAKAsLong()
        Get the OSN NAK (component 5) as Long
        Returns:
        the OSN NAK from component 5 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • getComponent6

        public java.lang.String getComponent6()
        Gets the component 6 (ACK Replay Indicator).
        Returns:
        the component 6

      • getComponent6AsLong

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

      • getACKReplayIndicator

        public java.lang.String getACKReplayIndicator()
        Gets the ACK Replay Indicator (component 6).
        Returns:
        the ACK Replay Indicator from component 6

      • getACKReplayIndicatorAsLong

        public java.lang.Long getACKReplayIndicatorAsLong()
        Get the ACK Replay Indicator (component 6) as Long
        Returns:
        the ACK Replay Indicator from component 6 converted to Long or null if cannot be converted
        Since:
        9.2.7

      • setComponent1

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

      • setComponent1

        public Field330 setComponent1​(java.lang.Number component1)
        Alternative method setter for field's Session Number (component 1) as Number

        This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

        Parameters:
        component1 - the Number with the Session Number content to set
        Returns:
        the field object to enable build pattern

      • setSessionNumber

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

      • setSessionNumber

        public Field330 setSessionNumber​(java.lang.Number component1)
        Alternative method setter for field's Session Number (component 1) as Number

        This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

        Parameters:
        component1 - the Number with the Session Number content to set
        Returns:
        the field object to enable build pattern

      • setComponent2

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

      • setComponent2

        public Field330 setComponent2​(java.lang.Number component2)
        Alternative method setter for field's ISN (component 2) as Number

        This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

        Parameters:
        component2 - the Number with the ISN content to set
        Returns:
        the field object to enable build pattern

      • setISN

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

      • setISN

        public Field330 setISN​(java.lang.Number component2)
        Alternative method setter for field's ISN (component 2) as Number

        This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

        Parameters:
        component2 - the Number with the ISN content to set
        Returns:
        the field object to enable build pattern

      • setComponent3

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

      • setComponent3

        public Field330 setComponent3​(java.lang.Number component3)
        Alternative method setter for field's ISN NAK (component 3) as Number

        This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

        Parameters:
        component3 - the Number with the ISN NAK content to set
        Returns:
        the field object to enable build pattern

      • setISNNAK

        public Field330 setISNNAK​(java.lang.String component3)
        Set the ISN NAK (component 3).
        Parameters:
        component3 - the ISN NAK to set
        Returns:
        the field object to enable build pattern

      • setISNNAK

        public Field330 setISNNAK​(java.lang.Number component3)
        Alternative method setter for field's ISN NAK (component 3) as Number

        This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

        Parameters:
        component3 - the Number with the ISN NAK content to set
        Returns:
        the field object to enable build pattern

      • setComponent4

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

      • setComponent4

        public Field330 setComponent4​(java.lang.Number component4)
        Alternative method setter for field's OSN (component 4) as Number

        This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

        Parameters:
        component4 - the Number with the OSN content to set
        Returns:
        the field object to enable build pattern

      • setOSN

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

      • setOSN

        public Field330 setOSN​(java.lang.Number component4)
        Alternative method setter for field's OSN (component 4) as Number

        This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

        Parameters:
        component4 - the Number with the OSN content to set
        Returns:
        the field object to enable build pattern

      • setComponent5

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

      • setComponent5

        public Field330 setComponent5​(java.lang.Number component5)
        Alternative method setter for field's OSN NAK (component 5) as Number

        This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

        Parameters:
        component5 - the Number with the OSN NAK content to set
        Returns:
        the field object to enable build pattern

      • setOSNNAK

        public Field330 setOSNNAK​(java.lang.String component5)
        Set the OSN NAK (component 5).
        Parameters:
        component5 - the OSN NAK to set
        Returns:
        the field object to enable build pattern

      • setOSNNAK

        public Field330 setOSNNAK​(java.lang.Number component5)
        Alternative method setter for field's OSN NAK (component 5) as Number

        This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

        Parameters:
        component5 - the Number with the OSN NAK content to set
        Returns:
        the field object to enable build pattern

      • setComponent6

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

      • setComponent6

        public Field330 setComponent6​(java.lang.Number component6)
        Alternative method setter for field's ACK Replay Indicator (component 6) as Number

        This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

        Parameters:
        component6 - the Number with the ACK Replay Indicator content to set
        Returns:
        the field object to enable build pattern

      • setACKReplayIndicator

        public Field330 setACKReplayIndicator​(java.lang.String component6)
        Set the ACK Replay Indicator (component 6).
        Parameters:
        component6 - the ACK Replay Indicator to set
        Returns:
        the field object to enable build pattern

      • setACKReplayIndicator

        public Field330 setACKReplayIndicator​(java.lang.Number component6)
        Alternative method setter for field's ACK Replay Indicator (component 6) as Number

        This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)

        Parameters:
        component6 - the Number with the ACK Replay Indicator content 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 Field330.NAME

      • get

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