Field94E (Prowide Integrator API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.field.Field
- - com.prowidesoftware.swift.model.field.Field94E

All Implemented Interfaces:

GenericField, MultiLineField, PatternContainer, Serializable
```
public class Field94E
extends Field
implements Serializable, GenericField, MultiLineField
```
Field 94E

validation pattern: :4!c//35x[$35x]0-9
parser pattern: :S//S[$S]0-9
components pattern: SSSSSSSSSSS

Components Data types
- component1: String
- component2: String
- component3: String
- component4: String
- component5: String
- component6: String
- component7: String
- component8: String
- component9: String
- component10: String
- component11: String
NOTE: this source code has been generated from template
Author:

www.prowidesoftware.com

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENTS_PATTERN`
`static String`	`F_94E` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 94E
`static String`	`PARSER_PATTERN`
`static Integer`	`QUALIFIER` Component number for the Qualifier subfield

Fields inherited from class com.prowidesoftware.swift.model.field.Field
components

Constructor Summary

Constructors
Constructor and Description

Field94E()
Default constructor

Field94E(String value)
Creates the field parsing the parameter value into fields' components

Constructors
Constructor and Description
`Field94E()` Default constructor
`Field94E(String value)` Creates the field parsing the parameter value into fields' components

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`componentsPattern()`
`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.
`static Tag`	`emptyTag()` Create a Tag with this field name and an empty string as value Shorthand for `new Tag(NAME, "")`
`static Field94E`	`get(SwiftMessage msg)` Get the first instance of Field94E in the given message.
`static Field94E`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field94E>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field94E in the given message an empty list is returned if none found.
`static List<Field94E>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field94E from the given block an empty list is returned if none found.
`String`	`getComponent1()` Get the component1
`String`	`getComponent10()` Get the component10
`String`	`getComponent10AsString()` Deprecated.
`String`	`getComponent11()` Get the component11
`String`	`getComponent11AsString()` Deprecated.
`String`	`getComponent1AsString()` Deprecated.
`String`	`getComponent2()` Get the component2
`String`	`getComponent2AsString()` Deprecated.
`String`	`getComponent3()` Get the component3
`String`	`getComponent3AsString()` Deprecated.
`String`	`getComponent4()` Get the component4
`String`	`getComponent4AsString()` Deprecated.
`String`	`getComponent5()` Get the component5
`String`	`getComponent5AsString()` Deprecated.
`String`	`getComponent6()` Get the component6
`String`	`getComponent6AsString()` Deprecated.
`String`	`getComponent7()` Get the component7
`String`	`getComponent7AsString()` Deprecated.
`String`	`getComponent8()` Get the component8
`String`	`getComponent8AsString()` Deprecated.
`String`	`getComponent9()` Get the component9
`String`	`getComponent9AsString()` Deprecated.
`String`	`getConditionalQualifier()` Gets the conditional qualifier. The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.
`String`	`getDSS()` Returns the issuer code (or Data Source Scheme or DSS).
`String`	`getLine(int line)` Returns a specific line from the field's value.
`String`	`getLine(int line, int offset)` Returns a specific line from the field's value.
`List<String>`	`getLines()` Returns the field value split into lines.
`List<String>`	`getLines(int offset)` Returns the field value starting at the offset component, split into lines.
`List<String>`	`getLinesBetween(int start, int end)` Returns a specific subset of lines from the field's value, given a range.
`List<String>`	`getLinesBetween(int start, int end, int offset)` Returns a specific subset of lines from the field's value, starting at the offset component.
`String`	`getName()` Deprecated. use constant Field94E
`String`	`getQualifier()` Get the Qualifier (component1).
`String`	`getValue()` Serializes the fields' components into the single string value (SWIFT format)
`boolean`	`isDSSPresent()` Checks if the issuer code (or Data Source Scheme or DSS) is present.
`boolean`	`isGeneric()` Returns true if the field is a GENERIC FIELD as specified by the standard.
`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.
`static Field94E`	`newInstance(Field94E source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`String`	`parserPattern()`
`Field94E`	`setComponent1(String component1)` Set the component1.
`Field94E`	`setComponent10(String component10)` Set the component10.
`Field94E`	`setComponent11(String component11)` Set the component11.
`Field94E`	`setComponent2(String component2)` Set the component2.
`Field94E`	`setComponent3(String component3)` Set the component3.
`Field94E`	`setComponent4(String component4)` Set the component4.
`Field94E`	`setComponent5(String component5)` Set the component5.
`Field94E`	`setComponent6(String component6)` Set the component6.
`Field94E`	`setComponent7(String component7)` Set the component7.
`Field94E`	`setComponent8(String component8)` Set the component8.
`Field94E`	`setComponent9(String component9)` Set the component9.
`Field94E`	`setQualifier(String component1)` Set the Qualifier (component1).
`static Tag`	`tag(String value)` Create a Tag with this field name and the given value.

Methods inherited from class com.prowidesoftware.swift.model.field.Field
appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponents, getField, getLabel, getLabel, getLabel, getLabel, getLine, getValueByCodeword, getValueDisplay, hashCode, is, is, is, isAnyOf, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NAME
```
public static final String NAME
```
    Constant with the field name 94E
    
    See Also:
    Constant Field Values
  - F_94E
```
public static final String F_94E
```
    same as NAME, intended to be clear when using static imports
    
    See Also:
    Constant Field Values
  - PARSER_PATTERN
```
public static final String PARSER_PATTERN
```
    See Also:
    Constant Field Values
  - COMPONENTS_PATTERN
```
public static final String COMPONENTS_PATTERN
```
    See Also:
    Constant Field Values
  - QUALIFIER
```
public static final Integer QUALIFIER
```
    Component number for the Qualifier subfield
- Constructor Detail
  - Field94E
```
public Field94E()
```
    Default constructor
  - Field94E
```
public Field94E(String value)
```
    Creates the field parsing the parameter value into fields' components
    
    Parameters:
    value -
- Method Detail
  - newInstance
```
public static Field94E newInstance(Field94E 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
  - getValue
```
public String getValue()
```
    Serializes the fields' components into the single string value (SWIFT format)
    
    Overrides:
    
    getValue in class Field
    
    Returns:
    SWIFT formatted value
  - tag
```
public static Tag tag(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
  - getComponent1
```
public String getComponent1()
```
    Get the component1
    
    Returns:
    the component1
  - getComponent1AsString
```
@Deprecated
public String getComponent1AsString()
```
    Deprecated.
    
    Same as getComponent(1)
  - getQualifier
```
public String getQualifier()
```
    Get the Qualifier (component1).
    
    Returns:
    the Qualifier from component1
  - setComponent1
```
public Field94E setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setQualifier
```
public Field94E setQualifier(String component1)
```
    Set the Qualifier (component1).
    
    Parameters:
    component1 - the Qualifier to set
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsString
```
@Deprecated
public String getComponent2AsString()
```
    Deprecated.
    
    Same as getComponent(2)
  - setComponent2
```
public Field94E setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsString
```
@Deprecated
public String getComponent3AsString()
```
    Deprecated.
    
    Same as getComponent(3)
  - setComponent3
```
public Field94E setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - getComponent4
```
public String getComponent4()
```
    Get the component4
    
    Returns:
    the component4
  - getComponent4AsString
```
@Deprecated
public String getComponent4AsString()
```
    Deprecated.
    
    Same as getComponent(4)
  - setComponent4
```
public Field94E setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 to set
  - getComponent5
```
public String getComponent5()
```
    Get the component5
    
    Returns:
    the component5
  - getComponent5AsString
```
@Deprecated
public String getComponent5AsString()
```
    Deprecated.
    
    Same as getComponent(5)
  - setComponent5
```
public Field94E setComponent5(String component5)
```
    Set the component5.
    
    Parameters:
    component5 - the component5 to set
  - getComponent6
```
public String getComponent6()
```
    Get the component6
    
    Returns:
    the component6
  - getComponent6AsString
```
@Deprecated
public String getComponent6AsString()
```
    Deprecated.
    
    Same as getComponent(6)
  - setComponent6
```
public Field94E setComponent6(String component6)
```
    Set the component6.
    
    Parameters:
    component6 - the component6 to set
  - getComponent7
```
public String getComponent7()
```
    Get the component7
    
    Returns:
    the component7
  - getComponent7AsString
```
@Deprecated
public String getComponent7AsString()
```
    Deprecated.
    
    Same as getComponent(7)
  - setComponent7
```
public Field94E setComponent7(String component7)
```
    Set the component7.
    
    Parameters:
    component7 - the component7 to set
  - getComponent8
```
public String getComponent8()
```
    Get the component8
    
    Returns:
    the component8
  - getComponent8AsString
```
@Deprecated
public String getComponent8AsString()
```
    Deprecated.
    
    Same as getComponent(8)
  - setComponent8
```
public Field94E setComponent8(String component8)
```
    Set the component8.
    
    Parameters:
    component8 - the component8 to set
  - getComponent9
```
public String getComponent9()
```
    Get the component9
    
    Returns:
    the component9
  - getComponent9AsString
```
@Deprecated
public String getComponent9AsString()
```
    Deprecated.
    
    Same as getComponent(9)
  - setComponent9
```
public Field94E setComponent9(String component9)
```
    Set the component9.
    
    Parameters:
    component9 - the component9 to set
  - getComponent10
```
public String getComponent10()
```
    Get the component10
    
    Returns:
    the component10
  - getComponent10AsString
```
@Deprecated
public String getComponent10AsString()
```
    Deprecated.
    
    Same as getComponent(10)
  - setComponent10
```
public Field94E setComponent10(String component10)
```
    Set the component10.
    
    Parameters:
    component10 - the component10 to set
  - getComponent11
```
public String getComponent11()
```
    Get the component11
    
    Returns:
    the component11
  - getComponent11AsString
```
@Deprecated
public String getComponent11AsString()
```
    Deprecated.
    
    Same as getComponent(11)
  - setComponent11
```
public Field94E setComponent11(String component11)
```
    Set the component11.
    
    Parameters:
    component11 - the component11 to set
  - 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
  - getDSS
```
public String getDSS()
```
    Returns the issuer code (or Data Source Scheme or DSS). The DSS is only present in some generic fields, when present, is equals to component two.
    
    Specified by:
    
    getDSS in interface GenericField
    
    Overrides:
    
    getDSS in class Field
    
    Returns:
    DSS component value or null if the DSS is not set or not available for this field.
  - isDSSPresent
```
public boolean isDSSPresent()
```
    Checks if the issuer code (or Data Source Scheme or DSS) is present.
    
    Specified by:
    
    isDSSPresent in interface GenericField
    
    Overrides:
    
    isDSSPresent in class Field
    
    Returns:
    true if DSS is present, false otherwise.
    See Also:
    getDSS()
  - getConditionalQualifier
```
public String getConditionalQualifier()
```
    Gets the conditional qualifier.
    The conditional qualifier is the the component following the DSS of generic fields, being component 2 or 3 depending on the field structure definition.
    
    Specified by:
    
    getConditionalQualifier in interface GenericField
    
    Overrides:
    
    getConditionalQualifier in class Field
    
    Returns:
    for generic fields returns the value of the conditional qualifier or null if not set or not applicable for this kind of field.
  - componentsPattern
```
public String componentsPattern()
```
    Specified by:
    
    componentsPattern in interface PatternContainer
  - parserPattern
```
public String parserPattern()
```
    Specified by:
    
    parserPattern in interface PatternContainer
  - getName
```
public String getName()
```
    Deprecated. use constant Field94E
    
    Description copied from class: Field
    
    Returns the field's name composed by the field number and the letter option (if any)
    
    Specified by:
    
    getName in class Field
  - get
```
public static Field94E get(SwiftTagListBlock block)
```
    Get 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 Field94E get(SwiftMessage msg)
```
    Get the first instance of Field94E 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 List<Field94E> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field94E 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 List<Field94E> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field94E 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
  - 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
  - getLine
```
public 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 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 List<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 List<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 offset)}
  - getLinesBetween
```
public List<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 start, int end)}
  - getLinesBetween
```
public List<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)}

Class Field94E

Components Data types

Field Summary

Fields inherited from class com.prowidesoftware.swift.model.field.Field

Constructor Summary

Method Summary

Methods inherited from class com.prowidesoftware.swift.model.field.Field

Methods inherited from class java.lang.Object

Field Detail

NAME

F_94E

PARSER_PATTERN

COMPONENTS_PATTERN

QUALIFIER

Constructor Detail

Field94E

Field94E

Method Detail

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsString

getQualifier

setComponent1

setQualifier

getComponent2

getComponent2AsString

setComponent2

getComponent3

getComponent3AsString

setComponent3

getComponent4

getComponent4AsString

setComponent4

getComponent5

getComponent5AsString

setComponent5

getComponent6

getComponent6AsString

setComponent6

getComponent7

getComponent7AsString

setComponent7

getComponent8

getComponent8AsString

setComponent8

getComponent9

getComponent9AsString

setComponent9

getComponent10

getComponent10AsString

setComponent10

getComponent11

getComponent11AsString

setComponent11

isOptional

isGeneric

getDSS

isDSSPresent

getConditionalQualifier

componentsPattern

parserPattern

getName

get

get

getAll

getAll

componentsSize

getLine

getLine

getLines

getLines

getLinesBetween

getLinesBetween