Field52A (Prowide Integrator API Reference)

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

All Implemented Interfaces:

BICContainer, MultiLineField, PatternContainer, Serializable
```
public class Field52A
extends Field
implements Serializable, BICContainer, MultiLineField
```
Field 52A

validation pattern: [[/<DC>][/34x]$]<SWIFTBIC>|<NON-SWIFTBIC>
parser pattern: [[/c][/S]$]S
components pattern: SSB

Components Data types
- component1: String
- component2: String
- component3: BIC
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 Integer`	`BIC` Component number for the BIC subfield
`static String`	`COMPONENTS_PATTERN`
`static Integer`	`DC_MARK` Component number for the D/C Mark subfield
`static String`	`F_52A` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 52A
`static String`	`PARSER_PATTERN`

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

Constructor Summary

Constructors
Constructor and Description

Field52A()
Default constructor

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

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

Method Summary

Methods
Modifier and Type	Method and Description
`List<BIC>`	`bics()` Utility method that creates a BIC for every string returned by `BICContainer.bicStrings()`
`List<String>`	`bicStrings()` Get a list of strings of BICs present in this field
`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 Field52A`	`get(SwiftMessage msg)` Get the first instance of Field52A in the given message.
`static Field52A`	`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<Field52A>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field52A in the given message an empty list is returned if none found.
`static List<Field52A>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field52A from the given block an empty list is returned if none found.
`String`	`getBIC()` Get the BIC (component3).
`BIC`	`getBICAsBIC()` Get the BIC (component3) as BIC
`String`	`getComponent1()` Get the component1
`String`	`getComponent1AsString()` Deprecated.
`String`	`getComponent2()` Get the component2
`String`	`getComponent2AsString()` Deprecated.
`String`	`getComponent3()` Get the component3
`BIC`	`getComponent3AsBIC()` Get the component3 as BIC
`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 Field52A
`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 Field52A`	`newInstance(Field52A source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`String`	`parserPattern()`
`Field52A`	`setAccount(String component2)` Set the Account (component2).
`Field52A`	`setBIC(BIC component3)` Set the BIC (component3) as BIC
`Field52A`	`setBIC(String component3)` Set the BIC (component3).
`Field52A`	`setComponent1(String component1)` Set the component1.
`Field52A`	`setComponent2(String component2)` Set the component2.
`Field52A`	`setComponent3(BIC component3)` Set the component3.
`Field52A`	`setComponent3(String component3)` Set the component3.
`Field52A`	`setDCMark(String component1)` Set the D/C Mark (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, 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 52A
    
    See Also:
    Constant Field Values
  - F_52A
```
public static final String F_52A
```
    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
  - BIC
```
public static final Integer BIC
```
    Component number for the BIC subfield
- Constructor Detail
  - Field52A
```
public Field52A()
```
    Default constructor
  - Field52A
```
public Field52A(String value)
```
    Creates the field parsing the parameter value into fields' components
    
    Parameters:
    value -
- Method Detail
  - newInstance
```
public static Field52A newInstance(Field52A 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 Field52A setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setDCMark
```
public Field52A 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 Field52A setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setAccount
```
public Field52A setAccount(String component2)
```
    Set the Account (component2).
    
    Parameters:
    component2 - the Account to set
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsBIC
```
public BIC getComponent3AsBIC()
```
    Get the component3 as BIC
    
    Returns:
    the component3 converted to BIC or null if cannot be converted
  - getBIC
```
public String getBIC()
```
    Get the BIC (component3).
    
    Returns:
    the BIC from component3
  - getBICAsBIC
```
public BIC getBICAsBIC()
```
    Get the BIC (component3) as BIC
    
    Returns:
    the BIC from component3 converted to BIC or null if cannot be converted
  - setComponent3
```
public Field52A setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setComponent3
```
public Field52A setComponent3(BIC component3)
```
    Set the component3.
    
    Parameters:
    component3 - the BIC with the component3 content to set
  - setBIC
```
public Field52A setBIC(String component3)
```
    Set the BIC (component3).
    
    Parameters:
    component3 - the BIC to set
  - setBIC
```
public Field52A setBIC(BIC component3)
```
    Set the BIC (component3) as BIC
    
    Parameters:
    component3 - BIC with the BIC content to set
  - bics
```
public List<BIC> bics()
```
    Description copied from interface: BICContainer
    
    Utility method that creates a BIC for every string returned by BICContainer.bicStrings()
    
    Specified by:
    
    bics in interface BICContainer
  - bicStrings
```
public List<String> bicStrings()
```
    Description copied from interface: BICContainer
    
    Get a list of strings of BICs present in this field
    
    Specified by:
    
    bicStrings in interface BICContainer
    
    Returns:
    a list, with zero or more BICs in this field.
  - 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 Field52A
    
    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 Field52A 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 Field52A get(SwiftMessage msg)
```
    Get the first instance of Field52A 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<Field52A> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field52A 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<Field52A> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field52A 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 Field52A

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_52A

PARSER_PATTERN

COMPONENTS_PATTERN

DC_MARK

ACCOUNT

BIC

Constructor Detail

Field52A

Field52A

Method Detail

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsString

getDCMark

setComponent1

setDCMark

getComponent2

getComponent2AsString

getAccount

setComponent2

setAccount

getComponent3

getComponent3AsBIC

getBIC

getBICAsBIC

setComponent3

setComponent3

setBIC

setBIC

bics

bicStrings

isOptional

isGeneric

componentsPattern

parserPattern

getName

get

get

getAll

getAll

componentsSize

getLine

getLine

getLines

getLines

getLinesBetween

getLinesBetween