Field82D (Prowide Integrator API Reference)

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

All Implemented Interfaces:

MultiLineField, PatternContainer, Serializable
```
public class Field82D
extends Field
implements Serializable, MultiLineField
```
Field 82D

validation pattern: [[/<DC>][/34x]$]35x[$35x]0-3
parser pattern: [[/c][/S]$]S[$S]0-3
components pattern: SSSSSS

Components Data types
- component1: String
- component2: String
- component3: String
- component4: String
- component5: String
- component6: 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 Integer`	`ACCOUNT` Component number for the Account subfield
`static String`	`COMPONENTS_PATTERN`
`static Integer`	`DC_MARK` Component number for the D/C Mark subfield
`static String`	`F_82D` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 82D
`static Integer`	`NAME_AND_ADDRESS` Component number for the Name And Address subfield
`static String`	`PARSER_PATTERN`

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

Constructor Summary

Constructors
Constructor and Description

Field82D()
Default constructor

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

Constructors
Constructor and Description
`Field82D()` Default constructor
`Field82D(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 Field82D`	`get(SwiftMessage msg)` Get the first instance of Field82D in the given message.
`static Field82D`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`String`	`getAccount()` Get the Account (component2) removing its starting slashes if any.
`static List<Field82D>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field82D in the given message an empty list is returned if none found.
`static List<Field82D>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field82D from the given block an empty list is returned if none found.
`String`	`getComponent1()` Get the component1
`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`	`getDCMark()` Get the D/C Mark (component1).
`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 Field82D
`String`	`getNameAndAddress()` Get the Name And Address as a concatenation of component3 to component6.
`String`	`getNameAndAddressLine1()` Get the Name And Address (component3).
`String`	`getNameAndAddressLine2()` Get the Name And Address (component4).
`String`	`getNameAndAddressLine3()` Get the Name And Address (component5).
`String`	`getNameAndAddressLine4()` Get the Name And Address (component6).
`String`	`getValue()` Serializes the fields' components into the single string value (SWIFT format)
`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 Field82D`	`newInstance(Field82D source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`String`	`parserPattern()`
`Field82D`	`setAccount(String component2)` Set the Account (component2).
`Field82D`	`setComponent1(String component1)` Set the component1.
`Field82D`	`setComponent2(String component2)` Set the component2.
`Field82D`	`setComponent3(String component3)` Set the component3.
`Field82D`	`setComponent4(String component4)` Set the component4.
`Field82D`	`setComponent5(String component5)` Set the component5.
`Field82D`	`setComponent6(String component6)` Set the component6.
`Field82D`	`setDCMark(String component1)` Set the D/C Mark (component1).
`Field82D`	`setNameAndAddress(String value)` Set the Name And Address splitting the parameter lines into components 3 to 6.
`Field82D`	`setNameAndAddressLine1(String component3)` Set the Name And Address (component3).
`Field82D`	`setNameAndAddressLine2(String component4)` Set the Name And Address (component4).
`Field82D`	`setNameAndAddressLine3(String component5)` Set the Name And Address (component5).
`Field82D`	`setNameAndAddressLine4(String component6)` Set the Name And Address (component6).
`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, getConditionalQualifier, getDSS, getField, getLabel, getLabel, getLabel, getLabel, getLine, getValueByCodeword, getValueDisplay, hashCode, is, is, is, isAnyOf, isDSSPresent, 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 82D
    
    See Also:
    Constant Field Values
  - F_82D
```
public static final String F_82D
```
    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
  - DC_MARK
```
public static final Integer DC_MARK
```
    Component number for the D/C Mark subfield
  - ACCOUNT
```
public static final Integer ACCOUNT
```
    Component number for the Account subfield
  - NAME_AND_ADDRESS
```
public static final Integer NAME_AND_ADDRESS
```
    Component number for the Name And Address subfield
- Constructor Detail
  - Field82D
```
public Field82D()
```
    Default constructor
  - Field82D
```
public Field82D(String value)
```
    Creates the field parsing the parameter value into fields' components
    
    Parameters:
    value -
- Method Detail
  - newInstance
```
public static Field82D newInstance(Field82D 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)
  - getDCMark
```
public String getDCMark()
```
    Get the D/C Mark (component1).
    
    Returns:
    the D/C Mark from component1
  - setComponent1
```
public Field82D setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setDCMark
```
public Field82D setDCMark(String component1)
```
    Set the D/C Mark (component1).
    
    Parameters:
    component1 - the D/C Mark to set
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsString
```
@Deprecated
public String getComponent2AsString()
```
    Deprecated.
    
    Same as getComponent(2)
  - getAccount
```
public String getAccount()
```
    Get the Account (component2) removing its starting slashes if any.
    
    Returns:
    the Account from component2
  - setComponent2
```
public Field82D setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setAccount
```
public Field82D setAccount(String component2)
```
    Set the Account (component2).
    
    Parameters:
    component2 - the Account to set
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsString
```
@Deprecated
public String getComponent3AsString()
```
    Deprecated.
    
    Same as getComponent(3)
  - getNameAndAddressLine1
```
public String getNameAndAddressLine1()
```
    Get the Name And Address (component3).
    
    Returns:
    the Name And Address from component3
  - getNameAndAddressLine2
```
public String getNameAndAddressLine2()
```
    Get the Name And Address (component4).
    
    Returns:
    the Name And Address from component4
  - getNameAndAddressLine3
```
public String getNameAndAddressLine3()
```
    Get the Name And Address (component5).
    
    Returns:
    the Name And Address from component5
  - getNameAndAddressLine4
```
public String getNameAndAddressLine4()
```
    Get the Name And Address (component6).
    
    Returns:
    the Name And Address from component6
  - getNameAndAddress
```
public String getNameAndAddress()
```
    Get the Name And Address as a concatenation of component3 to component6.
    
    Returns:
    the Name And Address from components
  - setComponent3
```
public Field82D setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setNameAndAddressLine1
```
public Field82D setNameAndAddressLine1(String component3)
```
    Set the Name And Address (component3).
    
    Parameters:
    component3 - the Name And Address to set
  - setNameAndAddressLine2
```
public Field82D setNameAndAddressLine2(String component4)
```
    Set the Name And Address (component4).
    
    Parameters:
    component4 - the Name And Address to set
  - setNameAndAddressLine3
```
public Field82D setNameAndAddressLine3(String component5)
```
    Set the Name And Address (component5).
    
    Parameters:
    component5 - the Name And Address to set
  - setNameAndAddressLine4
```
public Field82D setNameAndAddressLine4(String component6)
```
    Set the Name And Address (component6).
    
    Parameters:
    component6 - the Name And Address to set
  - setNameAndAddress
```
public Field82D setNameAndAddress(String value)
```
    Set the Name And Address splitting the parameter lines into components 3 to 6.
    
    Parameters:
    value - the Name And Address to set, may contain line ends and each line will be set to its correspondent component attribute
  - getComponent4
```
public String getComponent4()
```
    Get the component4
    
    Returns:
    the component4
  - getComponent4AsString
```
@Deprecated
public String getComponent4AsString()
```
    Deprecated.
    
    Same as getComponent(4)
  - setComponent4
```
public Field82D 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 Field82D 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 Field82D setComponent6(String component6)
```
    Set the component6.
    
    Parameters:
    component6 - the component6 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
  - 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 Field82D
    
    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 Field82D 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 Field82D get(SwiftMessage msg)
```
    Get the first instance of Field82D 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<Field82D> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field82D 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<Field82D> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field82D 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 Field82D

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_82D

PARSER_PATTERN

COMPONENTS_PATTERN

DC_MARK

ACCOUNT

NAME_AND_ADDRESS

Constructor Detail

Field82D

Field82D

Method Detail

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsString

getDCMark

setComponent1

setDCMark

getComponent2

getComponent2AsString

getAccount

setComponent2

setAccount

getComponent3

getComponent3AsString

getNameAndAddressLine1

getNameAndAddressLine2

getNameAndAddressLine3

getNameAndAddressLine4

getNameAndAddress

setComponent3

setNameAndAddressLine1

setNameAndAddressLine2

setNameAndAddressLine3

setNameAndAddressLine4

setNameAndAddress

getComponent4

getComponent4AsString

setComponent4

getComponent5

getComponent5AsString

setComponent5

getComponent6

getComponent6AsString

setComponent6

isOptional

isGeneric

componentsPattern

parserPattern

getName

get

get

getAll

getAll

componentsSize

getLine

getLine

getLines

getLines

getLinesBetween

getLinesBetween