Package com.prowidesoftware.swift.model.field

Class Field83A

    • 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 83A.
        See Also:
        Constant Field Values

      • F_83A

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

    • Constructor Detail

      • Field83A

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

      • Field83A

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

      • Field83A

        public Field83A​(Tag tag)
        Creates a new field and initializes its components with content from the parameter tag. The value is parsed with OptionAPartyField.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 Field83A newInstance​(Field83A 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

      • validatorPattern

        public final java.lang.String validatorPattern()
        Returns the field validator pattern.
        Specified by:
        validatorPattern in class OptionAPartyField

      • setComponent1

        public Field83A setComponent1​(java.lang.String component1)
        Set the component 1 (D/C Mark).
        Parameters:
        component1 - the D/C Mark to set
        Returns:
        the field object to enable build pattern

      • setDCMark

        public Field83A setDCMark​(java.lang.String component1)
        Set the D/C Mark (component 1).
        Parameters:
        component1 - the D/C Mark to set
        Returns:
        the field object to enable build pattern

      • setComponent2

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

      • setAccount

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

      • setComponent3

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

      • setComponent3

        public Field83A setComponent3​(BIC component3)
        Set the component3 from a BIC object.
        Parameters:
        component3 - the BIC with the Identifier Code content to set
        Returns:
        the field object to enable build pattern

      • setIdentifierCode

        public Field83A setIdentifierCode​(java.lang.String component3)
        Set the Identifier Code (component 3).
        Parameters:
        component3 - the Identifier Code to set
        Returns:
        the field object to enable build pattern

      • setIdentifierCode

        public Field83A setIdentifierCode​(BIC component3)
        Set the Identifier Code (component 3) from a BIC object.
        Parameters:
        component3 - BIC with the Identifier Code content to set
        Returns:
        the field object to enable build pattern
        See Also:
        setComponent3(com.prowidesoftware.swift.model.BIC)

      • setBIC

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

      • bicStrings

        public java.util.List<java.lang.String> bicStrings()
        Description copied from interface: BICContainer
        Get a list of strings of BICs present in this field
        Specified by:
        bicStrings in interface BICContainer
        Overrides:
        bicStrings in class OptionAPartyField
        Returns:
        a list, with zero or more BICs in this field.

      • 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 OptionAPartyField
        Returns:
        the static value of Field83A.NAME

      • get

        public static Field83A 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 Field83A get​(SwiftMessage msg)
        Gets the first instance of Field83A 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<Field83A> getAll​(SwiftMessage msg)
        Gets a list of all occurrences of the field Field83A 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<Field83A> getAll​(SwiftTagListBlock block)
        Gets a list of all occurrences of the field Field83A 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

      • getLine

        public java.lang.String getLine​(int line)
        Returns a specific line from the field's value.
        Specified by:
        getLine in interface MultiLineField
        Parameters:
        line - a reference to a specific line in the field, first line being 1
        Returns:
        line content or null if not present or if line number is above the expected
        Since:
        7.7
        See Also:
        MultiLineField.getLine(int)

      • getLine

        public java.lang.String getLine​(int line,
                                int offset)
        Returns a specific line from the field's value.
        Specified by:
        getLine in interface MultiLineField
        Parameters:
        line - a reference to a specific line in the field, first line being 1
        offset - an optional component number used as offset when counting lines
        Returns:
        line content or null if not present or if line number is above the expected
        Since:
        7.7
        See Also:
        MultiLineField.getLine(int, int)

      • getLines

        public java.util.List<java.lang.String> getLines()
        Returns the field value split into lines.
        Specified by:
        getLines in interface MultiLineField
        Returns:
        lines content or empty list if field's value is empty
        Since:
        7.7
        See Also:
        MultiLineField.getLines()

      • getLines

        public java.util.List<java.lang.String> getLines​(int offset)
        Returns the field value starting at the offset component, split into lines.
        Specified by:
        getLines in interface MultiLineField
        Parameters:
        offset - an optional component number used as offset when counting lines
        Returns:
        found lines or empty list if lines are not present or the offset is invalid
        Since:
        7.7
        See Also:
        MultiLineField.getLines(int)

      • getLinesBetween

        public java.util.List<java.lang.String> getLinesBetween​(int start,
                                                        int end)
        Returns a specific subset of lines from the field's value, given a range.
        Specified by:
        getLinesBetween in interface MultiLineField
        Parameters:
        start - a reference to a specific line in the field, first line being 1
        end - a reference to a specific line in the field, must be greater than start
        Returns:
        found lines or empty list if value is empty
        Since:
        7.7
        See Also:
        MultiLineField.getLinesBetween(int, int )

      • getLinesBetween

        public java.util.List<java.lang.String> getLinesBetween​(int start,
                                                        int end,
                                                        int offset)
        Returns a specific subset of lines from the field's value, starting at the offset component.
        Specified by:
        getLinesBetween in interface MultiLineField
        Parameters:
        start - a reference to a specific line in the field, first line being 1
        end - a reference to a specific line in the field, must be greater than start
        offset - an optional component number used as offset when counting lines
        Returns:
        found lines or empty list if lines are not present or the offset is invalid
        Since:
        7.7
        See Also:
        MultiLineField.getLinesBetween(int start, int end, int offset)

      • fromJson

        public static Field83A fromJson​(java.lang.String json)
        This method deserializes the JSON data into a Field83A 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)