Package com.prowidesoftware.swift.model.field

Class Field72

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

      • F_72

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

    • Constructor Detail

      • Field72

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

      • Field72

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

      • Field72

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

      • Field72

        public Field72​(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 Field72 newInstance​(Field72 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 Field72 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 Field72 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 Field72.NAME

      • get

        public static Field72 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 Field72 get​(SwiftMessage msg)
        Gets the first instance of Field72 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<Field72> getAll​(SwiftMessage msg)
        Gets a list of all occurrences of the field Field72 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<Field72> getAll​(SwiftTagListBlock block)
        Gets a list of all occurrences of the field Field72 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 Field72 fromJson​(java.lang.String json)
        This method deserializes the JSON data into a Field72 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 Field72 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 Field72 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 Field72 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 Field72 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 Field72 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 Field72 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 Field72 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 Field72 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 Field72 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 Field72 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 Field72 setNarrativeLine6​(java.lang.String component)
        Deprecated.
        this method does not set any value, use setNarrative(Narrative) or appendLine(String) instead