Package com.prowidesoftware.swift.model.field

Class Field256

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

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

    Subfields (components) Data types

    1. Component 1: LTAddress: LogicalTerminalAddress
    2. Component 2: SessionNumber: Long
    3. Component 3: MessageCategory: Long
    4. Component 4: Date: Calendar
    5. Component 5: StartTime: Calendar
    6. Component 6: EndTime: Calendar

    Structure definition

    • validation pattern: <LT>4!n1!n<DATE2>[<HHMM><HHMM>]
    • parser pattern: <LT>4!Nc<DATE2>[<HHMM><HHMM>]
    • components pattern: ZNNEHH

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

      • F_256

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

      • LT_ADDRESS

        public static final java.lang.Integer LT_ADDRESS
        Component number for the LT Address subfield.

      • SESSION_NUMBER

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

      • MESSAGE_CATEGORY

        public static final java.lang.Integer MESSAGE_CATEGORY
        Component number for the Message Category subfield.

      • DATE

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

      • START_TIME

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

      • END_TIME

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

    • Constructor Detail

      • Field256

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

      • Field256

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

      • Field256

        public Field256​(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 Field256 newInstance​(Field256 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 (LT Address).
        Returns:
        the component 1

      • getComponent1AsLogicalTerminalAddress

        public LogicalTerminalAddress getComponent1AsLogicalTerminalAddress()
        Get the component 1 as LogicalTerminalAddress
        Returns:
        the component 1 converted to LogicalTerminalAddress or null if cannot be converted

      • getLTAddress

        public java.lang.String getLTAddress()
        Gets the LT Address (component 1).
        Returns:
        the LT Address from component 1

      • getLTAddressAsLogicalTerminalAddress

        public LogicalTerminalAddress getLTAddressAsLogicalTerminalAddress()
        Get the LT Address (component 1) as LogicalTerminalAddress
        Returns:
        the LT Address from component 1 converted to LogicalTerminalAddress or null if cannot be converted

      • getComponent2

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

      • getSessionNumber

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

      • getSessionNumberAsLong

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

      • getSessionNumberAsNumber

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

      • getComponent3

        public java.lang.String getComponent3()
        Gets the component 3 (Message Category).
        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(phase4=SRU2024)
public java.lang.Number getComponent3AsNumber()
        Deprecated.
        use #getComponent3AsLong() instead

      • getMessageCategory

        public java.lang.String getMessageCategory()
        Gets the Message Category (component 3).
        Returns:
        the Message Category from component 3

      • getMessageCategoryAsLong

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

      • getMessageCategoryAsNumber

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

      • getComponent4

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

      • getComponent4AsCalendar

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

      • getDate

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

      • getDateAsCalendar

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

      • getComponent5

        public java.lang.String getComponent5()
        Gets the component 5 (Start Time).
        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

      • getStartTime

        public java.lang.String getStartTime()
        Gets the Start Time (component 5).
        Returns:
        the Start Time from component 5

      • getStartTimeAsCalendar

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

      • getComponent6

        public java.lang.String getComponent6()
        Gets the component 6 (End Time).
        Returns:
        the component 6

      • getComponent6AsCalendar

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

      • getEndTime

        public java.lang.String getEndTime()
        Gets the End Time (component 6).
        Returns:
        the End Time from component 6

      • getEndTimeAsCalendar

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

      • setComponent1

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

      • setComponent1

        public Field256 setComponent1​(LogicalTerminalAddress component1)
        Set the component1 from a LogicalTerminalAddress object.
        Parameters:
        component1 - the LogicalTerminalAddress with the LT Address content to set
        Returns:
        the field object to enable build pattern

      • setLTAddress

        public Field256 setLTAddress​(java.lang.String component1)
        Set the LT Address (component 1).
        Parameters:
        component1 - the LT Address to set
        Returns:
        the field object to enable build pattern

      • setComponent2

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

      • setComponent2

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

      • setComponent2

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

      • setSessionNumber

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

      • setSessionNumber

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

      • setSessionNumber

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

      • setComponent3

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

      • setComponent3

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

      • setComponent3

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

      • setMessageCategory

        public Field256 setMessageCategory​(java.lang.String component3)
        Set the Message Category (component 3).
        Parameters:
        component3 - the Message Category to set
        Returns:
        the field object to enable build pattern

      • setMessageCategory

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

      • setMessageCategory

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

      • setComponent4

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

      • setComponent4

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

      • setDate

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

      • setDate

        public Field256 setDate​(java.util.Calendar component4)
        Set the Date (component 4) from a Calendar object.
        Parameters:
        component4 - Calendar with the Date content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent4(java.util.Calendar)

      • setComponent5

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

      • setComponent5

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

      • setStartTime

        public Field256 setStartTime​(java.lang.String component5)
        Set the Start Time (component 5).
        Parameters:
        component5 - the Start Time to set
        Returns:
        the field object to enable build pattern

      • setStartTime

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

      • setComponent6

        public Field256 setComponent6​(java.lang.String component6)
        Set the component 6 (End Time).
        Parameters:
        component6 - the End Time to set
        Returns:
        the field object to enable build pattern

      • setComponent6

        public Field256 setComponent6​(java.util.Calendar component6)
        Set the component6 from a Calendar object.
        Parameters:
        component6 - the Calendar with the End Time content to set
        Returns:
        the field object to enable build pattern

      • setEndTime

        public Field256 setEndTime​(java.lang.String component6)
        Set the End Time (component 6).
        Parameters:
        component6 - the End Time to set
        Returns:
        the field object to enable build pattern

      • setEndTime

        public Field256 setEndTime​(java.util.Calendar component6)
        Set the End Time (component 6) from a Calendar object.
        Parameters:
        component6 - Calendar with the End Time content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent6(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 Field256.NAME

      • get

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