Package com.prowidesoftware.swift.model.field

Class Field77A

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

      • F_77A

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

    • Constructor Detail

      • Field77A

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

      • Field77A

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

      • Field77A

        public Field77A​(Tag tag)
        Creates a new field and initializes its components with content from the parameter tag. The value is parsed with StructuredNarrativeField.parse(String)
        Throws:
        java.lang.IllegalArgumentException - if the parameter tag is null or its tagname does not match the field name
        Since:
        7.8

      • Field77A

        public Field77A​(Narrative narrative)
        Creates a new field from a Narrative instance.
        Parameters:
        narrative - a not-null narrative to use as field value
        Since:
        8.1.0
        See Also:
        Narrative.builder(int)

    • Method Detail

      • newInstance

        public static Field77A newInstance​(Field77A 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

      • setComponent1

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

      • setNarrative

        public Field77A setNarrative​(java.lang.String component1)
        Set the Narrative (component 1).
        Parameters:
        component1 - the Narrative 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 StructuredNarrativeField
        Returns:
        the static value of Field77A.NAME

      • get

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

      • getNarrativeLine1

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine1()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine1

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine1​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent2

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent2()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent2

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent2​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine2

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine2()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine2

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine2​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent3

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent3()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent3

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent3​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine3

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine3()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine3

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine3​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent4

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent4()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent4

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent4​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine4

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine4()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine4

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine4​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent5

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent5()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent5

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent5​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine5

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine5()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine5

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine5​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent6

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent6()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent6

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent6​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine6

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine6()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine6

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine6​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent7

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent7()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent7

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent7​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine7

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine7()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine7

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine7​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent8

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent8()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent8

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent8​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine8

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine8()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine8

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine8​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent9

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent9()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent9

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent9​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine9

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine9()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine9

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine9​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent10

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent10()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent10

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent10​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine10

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine10()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine10

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine10​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent11

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent11()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent11

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent11​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine11

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine11()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine11

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine11​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent12

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent12()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent12

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent12​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine12

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine12()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine12

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine12​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent13

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent13()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent13

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent13​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine13

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine13()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine13

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine13​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent14

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent14()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent14

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent14​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine14

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine14()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine14

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine14​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent15

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent15()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent15

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent15​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine15

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine15()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine15

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine15​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent16

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent16()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent16

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent16​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine16

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine16()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine16

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine16​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent17

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent17()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent17

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent17​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine17

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine17()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine17

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine17​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent18

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent18()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent18

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent18​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine18

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine18()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine18

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine18​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent19

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent19()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent19

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent19​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine19

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine19()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine19

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine19​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getComponent20

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getComponent20()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setComponent20

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setComponent20​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead

      • getNarrativeLine20

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public java.lang.String getNarrativeLine20()
        Deprecated.
        Use getLine(int) or narrative() instead

      • setNarrativeLine20

        @Deprecated
@ProwideDeprecated(phase4=SRU2023)
public Field77A setNarrativeLine20​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead