Package com.prowidesoftware.swift.model.field

Class Field98G

  • All Implemented Interfaces:
    JsonSerializable, DateContainer, PatternContainer, java.io.Serializable
    @Generated
public class Field98G
extends Field
implements java.io.Serializable, DateContainer
    SWIFT MT Field 98G.

    Model and parser for field 98G of a SWIFT MT message.

    Subfields (components) Data types

    1. Component 1: Date: Calendar
    2. Component 2: Time: Calendar
    3. Component 3: Decimals: Long
    4. Component 4: Sign: String
    5. Component 5: Offset: Calendar

    Structure definition

    • validation pattern: <DATE4><TIME2>[,3n][/[<N>]<TIME3>]
    • parser pattern: <DATE4><TIME2>[,S][/[c]<TIME3>]
    • components pattern: DTNSW

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

      • F_98G

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

      • DATE

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

      • TIME

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

      • DECIMALS

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

      • NUMBER

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

      • SIGN

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

      • OFFSET

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

    • Constructor Detail

      • Field98G

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

      • Field98G

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

      • Field98G

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

      • getComponent1AsCalendar

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

      • getDate

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

      • getDateAsCalendar

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

      • getComponent2

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

      • getTime

        public java.lang.String getTime()
        Gets the Time (component 2).
        Returns:
        the Time from component 2

      • getTimeAsCalendar

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

      • getComponent3

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

      • getDecimals

        public java.lang.String getDecimals()
        Gets the Decimals (component 3).
        Returns:
        the Decimals from component 3

      • getDecimalsAsLong

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

      • getDecimalsAsNumber

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getDecimalsAsNumber()
        Deprecated.
        Get the Decimals (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:
        getDecimalsAsLong()

      • getNumberAsNumber

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public java.lang.Number getNumberAsNumber()
        Deprecated.
        Alternative DEPRECATED method getter for field's Decimals (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:
        getDecimalsAsLong()

      • getComponent4

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

      • getSign

        public java.lang.String getSign()
        Gets the Sign (component 4).
        Returns:
        the Sign from component 4

      • getComponent5

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

      • getComponent5AsCalendar

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

      • getOffset

        public java.lang.String getOffset()
        Gets the Offset (component 5).
        Returns:
        the Offset from component 5

      • getOffsetAsCalendar

        public java.util.Calendar getOffsetAsCalendar()
        Get the Offset (component 5) as Calendar
        Returns:
        the Offset from component 5 converted to Calendar or null if cannot be converted

      • setComponent1

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

      • setComponent1

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

      • setDate

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

      • setDate

        public Field98G setDate​(java.util.Calendar component1)
        Set the Date (component 1) from a Calendar object.
        Parameters:
        component1 - Calendar with the Date content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent1(java.util.Calendar)

      • setComponent2

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

      • setComponent2

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

      • setTime

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

      • setTime

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

      • setComponent3

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

      • setComponent3

        public Field98G 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 Decimals content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent3(String)

      • setComponent3

        public Field98G setComponent3​(java.lang.Number component3)
        Alternative method setter for field's Decimals (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 Decimals content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setDecimals(java.lang.Long)

      • setDecimals

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

      • setDecimals

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

      • setDecimals

        public Field98G setDecimals​(java.lang.Number component3)
        Alternative method setter for field's Decimals (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 Decimals content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setDecimals(java.lang.Long)

      • setNumber

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public Field98G setNumber​(java.lang.String component3)
        Deprecated.
        Alternative DEPRECATED method setter for field's Decimals
        Parameters:
        component3 - the Decimals to set
        Returns:
        the field object to enable build pattern
        See Also:
        setDecimals(String)

      • setNumber

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public Field98G setNumber​(java.lang.Long component3)
        Deprecated.
        Alternative DEPRECATED method setter for field's Decimals from a Long object.
        Parameters:
        component3 - Long with the Decimals content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent3(java.lang.Long)

      • setNumber

        @Deprecated
@ProwideDeprecated(phase3=SRU2023)
public Field98G setNumber​(java.lang.Number component3)
        Deprecated.
        Alternative DEPRECATED method setter for field's Decimals (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 Decimals content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setDecimals(java.lang.Long)

      • setComponent4

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

      • setSign

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

      • setComponent5

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

      • setComponent5

        public Field98G setComponent5​(java.util.Calendar component5)
        Set the component5 from a Calendar object.
        Parameters:
        component5 - the Calendar with the Offset content to set
        Returns:
        the field object to enable build pattern

      • setOffset

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

      • setOffset

        public Field98G setOffset​(java.util.Calendar component5)
        Set the Offset (component 5) from a Calendar object.
        Parameters:
        component5 - Calendar with the Offset content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent5(java.util.Calendar)

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

      • get

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

      • getUtcIndicator

        public java.lang.String getUtcIndicator()
        Get the ISO UTC Indicator combining the sign and offset, and changing the "N" negative sign indication by proper +/- signs
        Returns:
        the the UTC indicator such as +0100 or -0300

      • getTime2

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getTime2()
        Deprecated.
        Use getOffset() or getUtcIndicator() instead, the later returns both the sign and offset

      • getTime2AsCalendar

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.util.Calendar getTime2AsCalendar()
        Deprecated.
        Use getOffsetAsCalendar() instead