Package com.prowidesoftware.swift.model.field

Class Field14S

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

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

    Subfields (components) Data types

    1. Component 1: Source: String
    2. Component 2: Number: Long
    3. Component 3: Time: Calendar
    4. Component 4: Location: String

    Structure definition

    • validation pattern: 3!a2!n[/<HHMM>/4!c]
    • parser pattern: SN[/<HHMM>/S]
    • components pattern: SNHS

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

      • F_14S

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

      • SOURCE

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

      • NUMBER

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

      • TIME

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

      • LOCATION

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

    • Constructor Detail

      • Field14S

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

      • Field14S

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

      • Field14S

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

      • getSource

        public java.lang.String getSource()
        Gets the Source (component 1).
        Returns:
        the Source from component 1

      • getComponent2

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

      • getNumber

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

      • getNumberAsLong

        public java.lang.Long getNumberAsLong()
        Get the Number (component 2) as Long
        Returns:
        the Number 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 (Time).
        Returns:
        the component 3

      • getComponent3AsCalendar

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

      • getTime

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

      • getTimeAsCalendar

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

      • getComponent4

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

      • getLocation

        public java.lang.String getLocation()
        Gets the Location (component 4).
        Returns:
        the Location from component 4

      • setComponent1

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

      • setSource

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

      • setComponent2

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

      • setComponent2

        public Field14S setComponent2​(java.lang.Number component2)
        Alternative method setter for field's Number (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 Number content to set
        Returns:
        the field object to enable build pattern

      • setNumber

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

      • setNumber

        public Field14S setNumber​(java.lang.Number component2)
        Alternative method setter for field's Number (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 Number content to set
        Returns:
        the field object to enable build pattern

      • setComponent3

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

      • setComponent3

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

      • setTime

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

      • setTime

        public Field14S setTime​(java.util.Calendar component3)
        Set the Time (component 3) from a Calendar object.
        Parameters:
        component3 - Calendar with the Time content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent3(java.util.Calendar)

      • setComponent4

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

      • setLocation

        public Field14S setLocation​(java.lang.String component4)
        Set the Location (component 4).
        Parameters:
        component4 - the Location 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 Field14S.NAME

      • get

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

      • getRateSource

        public java.lang.String getRateSource()
        Gets the Rate Source (components 1 and 2) as a unit
        Returns:
        the concatenated values of component 1 and 2
        Since:
        9.2.7

      • setRateSource

        public Field14S setRateSource​(java.lang.String rateSource)
        Sets the Rate Source (components 1 and 2) as a unit
        Parameters:
        rateSource - the new expected value for components 1 and 2 concatenated
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7

      • getTimeAndLocation

        public java.lang.String getTimeAndLocation()
        Gets the Time And Location (components 3 and 4) as a unit
        Returns:
        the concatenated values of component 3 and 4 with the separating "/"
        Since:
        9.2.7

      • setTimeAndLocation

        public Field14S setTimeAndLocation​(java.lang.String timeAndLocation)
        Sets the Time And Location (components 3 and 4) as a unit
        Parameters:
        timeAndLocation - the new expected value for components 3 and 4 concatenated, including "/
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7