Package com.prowidesoftware.swift.model.field

Class Field37C

  • All Implemented Interfaces:
    JsonSerializable, AmountContainer, DateContainer, PatternContainer, java.io.Serializable
    @Generated
public class Field37C
extends Field
implements java.io.Serializable, AmountContainer, DateContainer
    SWIFT MT Field 37C.

    Model and parser for field 37C of a SWIFT MT message.

    Subfields (components) Data types

    1. Component 1: Rate: BigDecimal
    2. Component 2: EndDate: Calendar
    3. Component 3: Period: String
    4. Component 4: Number: Long
    5. Component 5: Information: String

    Structure definition

    • validation pattern: <AMOUNT>12[//<DATE2><DM>3n][/16x]
    • parser pattern: N[//<DATE2>cS][/S]
    • components pattern: NESNS

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

      • F_37C

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

      • RATE

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

      • END_DATE

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

      • PERIOD

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

      • NUMBER

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

      • NUMBER_OF_DAYSMONTHS

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public static final java.lang.Integer NUMBER_OF_DAYSMONTHS
        Deprecated.
        use #NUMBER instead

      • INFORMATION

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

    • Constructor Detail

      • Field37C

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

      • Field37C

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

      • Field37C

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

      • getComponent1AsBigDecimal

        public java.math.BigDecimal getComponent1AsBigDecimal()
        Get the component 1 as BigDecimal
        Returns:
        the component 1 converted to BigDecimal or null if cannot be converted
        Since:
        9.2.7

      • getComponent1AsNumber

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

      • getRate

        public java.lang.String getRate()
        Gets the Rate (component 1).
        Returns:
        the Rate from component 1

      • getRateAsBigDecimal

        public java.math.BigDecimal getRateAsBigDecimal()
        Get the Rate (component 1) as BigDecimal
        Returns:
        the Rate from component 1 converted to BigDecimal or null if cannot be converted
        Since:
        9.2.7

      • getRateAsNumber

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

      • getComponent2

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

      • getEndDate

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

      • getDate

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.String getDate()
        Deprecated.
        use #getEndDate() instead
        Alternative DEPRECATED method getter for field's End Date
        Since:
        9.2.7

      • getEndDateAsCalendar

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

      • getDateAsCalendar

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.util.Calendar getDateAsCalendar()
        Deprecated.
        use #getEndDateAsCalendar() instead

      • getComponent3

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

      • getPeriod

        public java.lang.String getPeriod()
        Gets the Period (component 3).
        Returns:
        the Period from component 3

      • getDMMark

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.String getDMMark()
        Deprecated.
        use #getPeriod() instead
        Alternative DEPRECATED method getter for field's Period
        Since:
        9.2.7

      • getComponent4

        public java.lang.String getComponent4()
        Gets the component 4 (Number).
        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(phase4=SRU2024)
public java.lang.Number getComponent4AsNumber()
        Deprecated.
        use #getComponent4AsLong() instead

      • getNumber

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

      • getNumberofDaysMonths

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.String getNumberofDaysMonths()
        Deprecated.
        use #getNumber() instead
        Alternative DEPRECATED method getter for field's Number
        Since:
        9.2.7

      • getNumberAsLong

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

      • getNumberAsNumber

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

      • getNumberofDaysMonthsAsLong

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public java.lang.Long getNumberofDaysMonthsAsLong()
        Deprecated.
        use #getNumberAsLong() instead

      • getNumberofDaysMonthsAsNumber

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

      • getComponent5

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

      • getInformation

        public java.lang.String getInformation()
        Gets the Information (component 5).
        Returns:
        the Information from component 5

      • setComponent1

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

      • setComponent1

        public Field37C setComponent1​(java.math.BigDecimal component1)
        Set the component1 from a BigDecimal object.
        Parses the BigDecimal into a SWIFT amount with truncated zero decimals and mandatory decimal separator.
        • Example: 1234.00 -> 1234,
        • Example: 1234 -> 1234,
        • Example: 1234.56 -> 1234,56
        Parameters:
        component1 - the BigDecimal with the Rate content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7

      • setComponent1

        public Field37C setComponent1​(java.lang.Number component1)
        Alternative method setter for field's Rate (component 1) as as Number This method supports java constant value boxing for simpler coding styles (ex: 10.0 becomes an Float)
        Parameters:
        component1 - the Number with the Rate content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setRate(java.math.BigDecimal)

      • setRate

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

      • setRate

        public Field37C setRate​(java.math.BigDecimal component1)
        Set the Rate (component 1) from a BigDecimal object.
        Parameters:
        component1 - BigDecimal with the Rate content to set
        Returns:
        the field object to enable build pattern
        Since:
        9.2.7
        See Also:
        setComponent1(java.math.BigDecimal)

      • setRate

        public Field37C setRate​(java.lang.Number component1)
        Alternative method setter for field's Rate (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 Rate content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setRate(java.math.BigDecimal)

      • setComponent2

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

      • setComponent2

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

      • setEndDate

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

      • setEndDate

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

      • setComponent3

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

      • setPeriod

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

      • setComponent4

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

      • setComponent4

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

      • setComponent4

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

      • setNumber

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

      • setNumber

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

      • setNumber

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

      • setNumberofDaysMonths

        @Deprecated
@ProwideDeprecated(phase4=SRU2024)
public Field37C setNumberofDaysMonths​(java.lang.Long component4)
        Deprecated.
        use #setComponent4(java.lang.Long) instead
        Since:
        9.2.7

      • setComponent5

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

      • setInformation

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

      • amounts

        public java.util.List<java.math.BigDecimal> amounts()
        Returns the list of all NON-NULL amounts as BigDecimal
        Returns:
        the list of NON-NULL amounts as BigDecimal values
        See Also:
        AmountResolver.amounts(Field)

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

      • get

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