Package com.prowidesoftware.swift.model.field

Class Field28

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

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

    Subfields (components) Data types

    1. Component 1: StatementNumber: Long
    2. Component 2: SequenceNumber: Long

    Structure definition

    • validation pattern: 5n[/2n]
    • parser pattern: S[/S]
    • components pattern: NN

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

      • F_28

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

      • STATEMENT_NUMBER

        public static final java.lang.Integer STATEMENT_NUMBER
        Component number for the Statement Number subfield.

      • SETTLEMENT_NUMBER

        public static final java.lang.Integer SETTLEMENT_NUMBER
        Alternative constant name for field's Statement Number Component number.
        See Also:
        STATEMENT_NUMBER

      • SEQUENCE_NUMBER

        public static final java.lang.Integer SEQUENCE_NUMBER
        Component number for the Sequence Number subfield.

      • PAGE_NUMBER

        public static final java.lang.Integer PAGE_NUMBER
        Alternative constant name for field's Sequence Number Component number.
        See Also:
        SEQUENCE_NUMBER

    • Constructor Detail

      • Field28

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

      • Field28

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

      • Field28

        public Field28​(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 Field28 newInstance​(Field28 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 (Statement 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

      • getComponent1AsNumber

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.Number getComponent1AsNumber()
        Deprecated.
        use #getComponent1AsLong() instead

      • getStatementNumber

        public java.lang.String getStatementNumber()
        Gets the Statement Number (component 1).
        Returns:
        the Statement Number from component 1

      • getSettlementNumber

        public java.lang.String getSettlementNumber()
        Deprecated.
        use #getStatementNumber() instead
        Alternative method getter for field's Statement Number
        Since:
        9.2.7

      • getStatementNumberAsLong

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

      • getStatementNumberAsNumber

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.Number getStatementNumberAsNumber()
        Deprecated.
        use #getStatementNumberAsLong() instead

      • getSettlementNumberAsLong

        public java.lang.Long getSettlementNumberAsLong()
        Deprecated.
        use #getStatementNumberAsLong() instead
        Since:
        9.2.7

      • getSettlementNumberAsNumber

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.Number getSettlementNumberAsNumber()
        Deprecated.
        use #getStatementNumberAsLong() instead

      • getComponent2

        public java.lang.String getComponent2()
        Gets the component 2 (Sequence Number).
        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

      • getComponent2AsNumber

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.Number getComponent2AsNumber()
        Deprecated.
        use #getComponent2AsLong() instead

      • getSequenceNumber

        public java.lang.String getSequenceNumber()
        Gets the Sequence Number (component 2).
        Returns:
        the Sequence Number from component 2

      • getPageNumber

        public java.lang.String getPageNumber()
        Deprecated.
        use #getSequenceNumber() instead
        Alternative method getter for field's Sequence Number
        Since:
        9.2.7

      • getSequenceNumberAsLong

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

      • getSequenceNumberAsNumber

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.Number getSequenceNumberAsNumber()
        Deprecated.
        use #getSequenceNumberAsLong() instead

      • getPageNumberAsLong

        public java.lang.Long getPageNumberAsLong()
        Deprecated.
        use #getSequenceNumberAsLong() instead
        Since:
        9.2.7

      • getPageNumberAsNumber

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.Number getPageNumberAsNumber()
        Deprecated.
        use #getSequenceNumberAsLong() instead

      • setComponent1

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

      • setComponent1

        public Field28 setComponent1​(java.lang.Long component1)
        Set the component1 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 setComponent1(String) method.
        Parameters:
        component1 - the Long with the Statement Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent1(String)

      • setComponent1

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

      • setStatementNumber

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

      • setStatementNumber

        public Field28 setStatementNumber​(java.lang.Long component1)
        Set the Statement Number (component 1) from a Long object.
        Parameters:
        component1 - Long with the Statement Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent1(java.lang.Long)

      • setStatementNumber

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

      • setSettlementNumber

        public Field28 setSettlementNumber​(java.lang.String component1)
        Deprecated.
        use #setStatementNumber(String) instead

      • setSettlementNumber

        public Field28 setSettlementNumber​(java.lang.Long component1)
        Deprecated.
        use #setComponent1(java.lang.Long) instead
        Since:
        9.2.7

      • setSettlementNumber

        public Field28 setSettlementNumber​(java.lang.Number component1)
        Deprecated.
        use #setStatementNumber(java.lang.Long) instead

      • setComponent2

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

      • setComponent2

        public Field28 setComponent2​(java.lang.Long component2)
        Set the component2 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 setComponent2(String) method.
        Parameters:
        component2 - the Long with the Sequence Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent2(String)

      • setComponent2

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

      • setSequenceNumber

        public Field28 setSequenceNumber​(java.lang.String component2)
        Set the Sequence Number (component 2).
        Parameters:
        component2 - the Sequence Number to set
        Returns:
        the field object to enable build pattern

      • setSequenceNumber

        public Field28 setSequenceNumber​(java.lang.Long component2)
        Set the Sequence Number (component 2) from a Long object.
        Parameters:
        component2 - Long with the Sequence Number content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent2(java.lang.Long)

      • setSequenceNumber

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

      • setPageNumber

        public Field28 setPageNumber​(java.lang.String component2)
        Deprecated.
        use #setSequenceNumber(String) instead

      • setPageNumber

        public Field28 setPageNumber​(java.lang.Long component2)
        Deprecated.
        use #setComponent2(java.lang.Long) instead
        Since:
        9.2.7

      • setPageNumber

        public Field28 setPageNumber​(java.lang.Number component2)
        Deprecated.
        use #setSequenceNumber(java.lang.Long) instead

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

      • get

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