OptionDPartyField (Prowide Core API Reference)

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

All Implemented Interfaces:

JsonSerializable, PartyIdentifier, PatternContainer

Direct Known Subclasses:

Field42D, Field50D, Field51D, Field52D, Field53D, Field54D, Field55D, Field56D, Field57D, Field58D, Field81D, Field82D, Field83D, Field84D, Field85D, Field86D, Field87D, Field88D, Field89D, Field91D, Field96D
```
public abstract class OptionDPartyField
extends Field
implements PartyIdentifier
```
Name and Address
Subfields (components) Data types
1. String
2. String
3. String
4. String
5. String
6. String
Structure definition
- parser pattern: [[/c][/S]$]S[$S]0-3
- components pattern: SSSSSS
Since:

7.11.0

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.Integer`	`ACCOUNT` Component number for the Account subfield
`static java.lang.String`	`COMPONENTS_PATTERN` Deprecated. Use `typesPattern()` instead
`static java.lang.Integer`	`DC_MARK` Component number for the D/C Mark subfield
`static java.lang.Integer`	`NAME_AND_ADDRESS` Component number for the Name And Address subfield
`static java.lang.String`	`PARSER_PATTERN`
`static java.lang.String`	`TYPES_PATTERN` Types pattern Contains a description of the type of each component

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

Constructor Summary

Constructors
Constructor and Description
`OptionDPartyField()` Default constructor.
`OptionDPartyField(java.lang.String value)` Creates a new field and initializes its components with content from the parameter value.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`componentsPattern()` Deprecated. Use `typesPattern()` instead
`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.
`java.lang.String`	`getAccount()` Gets the Account (component2) removing its starting slashes if any.
`java.lang.String`	`getComponent1()` Gets the component1 (D/C Mark).
`java.lang.String`	`getComponent2()` Gets the component2 (Account).
`java.lang.String`	`getComponent3()` Gets the component3 (Name And Address).
`java.lang.String`	`getComponent4()` Gets the component4 (Name And Address).
`java.lang.String`	`getComponent5()` Gets the component5 (Name And Address).
`java.lang.String`	`getComponent6()` Gets the component6 (Name And Address).
`java.util.List<java.lang.String>`	`getComponentLabels()` Returns english label for components.
`protected java.util.Map<java.lang.Integer,java.lang.String>`	`getComponentMap()` Returns a mapping between component numbers and their label in camel case format.
`java.lang.String`	`getDCMark()` Gets the D/C Mark (component1).
`abstract java.lang.String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`java.lang.String`	`getNameAndAddress()` Gets the Name And Address as a concatenation of component3 to component6.
`java.lang.String`	`getNameAndAddressLine1()` Gets the Name And Address (component3).
`java.lang.String`	`getNameAndAddressLine2()` Gets the Name And Address (component4).
`java.lang.String`	`getNameAndAddressLine3()` Gets the Name And Address (component5).
`java.lang.String`	`getNameAndAddressLine4()` Gets the Name And Address (component6).
`java.lang.String`	`getPartyIdentifier()` Get the formatted Party Identifier (CD Mark + Account) The Party Indentifier has the following format: `[/{cd-mark}]/{account}`
`java.lang.String`	`getValue()` Serializes the fields' components into the single string value (SWIFT format)
`java.lang.String`	`getValueDisplay(int component, java.util.Locale locale)` Returns a localized suitable for showing to humans string of a field component.
`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.
`void`	`parse(java.lang.String value)` Parses the parameter value into the internal components structure.
`java.lang.String`	`parserPattern()` Returns the field parser pattern
`OptionDPartyField`	`setPartyIdentifier(java.lang.String partyIdentifier)` Set the formatted Party Identifier (CD Mark + Account) The Party Indentifier has the following format: `[/{cd-mark}]/{account}` If the format is not valid
`java.lang.String`	`typesPattern()` Returns the field component types pattern This method returns a letter representing the type for each component in the Field.
`abstract java.lang.String`	`validatorPattern()` Returns the field validator pattern, that could vary er specific field

Methods inherited from class com.prowidesoftware.swift.model.field.Field
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, fromJson, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getField, getField, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, is, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, toJson, toString, validName

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

- Field Detail
  - PARSER_PATTERN
```
public static final java.lang.String PARSER_PATTERN
```
    See Also:
    
    Constant Field Values
  - COMPONENTS_PATTERN
```
@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public static final java.lang.String COMPONENTS_PATTERN
```
    Deprecated. Use typesPattern() instead
    
    See Also:
    
    Constant Field Values
  - TYPES_PATTERN
```
public static final java.lang.String TYPES_PATTERN
```
    Types pattern Contains a description of the type of each component
    
    See Also:
    
    Constant Field Values
  - DC_MARK
```
public static final java.lang.Integer DC_MARK
```
    Component number for the D/C Mark subfield
  - ACCOUNT
```
public static final java.lang.Integer ACCOUNT
```
    Component number for the Account subfield
  - NAME_AND_ADDRESS
```
public static final java.lang.Integer NAME_AND_ADDRESS
```
    Component number for the Name And Address subfield
- Constructor Detail
  - OptionDPartyField
```
public OptionDPartyField()
```
    Default constructor. Creates a new field setting all components to null.
  - OptionDPartyField
```
public OptionDPartyField(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
- Method Detail
  - parse
```
public void parse(java.lang.String value)
```
    Parses the parameter value into the internal components structure.
    Used to update all components from a full new value, as an alternative to setting individual components. Previous component values are overwritten.
    
    Specified by:
    
    parse in class Field
    
    Parameters:
    
    value - complete field value including separators and CRLF
    
    Since:
    
    7.8
  - getValue
```
public java.lang.String getValue()
```
    Serializes the fields' components into the single string value (SWIFT format)
    
    Specified by:
    
    getValue in class Field
    
    Returns:
    
    SWIFT formatted value
  - getValueDisplay
```
public java.lang.String getValueDisplay(int component,
                                        java.util.Locale locale)
```
    Returns a localized suitable for showing to humans string of a field component.
    
    Specified by:
    
    getValueDisplay in class Field
    
    Parameters:
    
    component - number of the component to display
    
    locale - optional locale to format date and amounts, if null, the default locale is used
    
    Returns:
    
    formatted component value or null if component number is invalid or not present
    
    Throws:
    
    java.lang.IllegalArgumentException - if component number is invalid for the field
    
    Since:
    
    7.8
  - componentsPattern
```
@Deprecated
 @ProwideDeprecated(phase3=SRU2023)
public final java.lang.String componentsPattern()
```
    Deprecated. Use typesPattern() instead
    
    Specified by:
    
    componentsPattern in class Field
  - typesPattern
```
public final java.lang.String typesPattern()
```
    Returns the field component types pattern This method returns a letter representing the type for each component in the Field. It supersedes the Components Pattern because it distinguishes between N (Number) and I (BigDecimal).
    
    Specified by:
    
    typesPattern in interface PatternContainer
    
    Specified by:
    
    typesPattern in class Field
    
    Returns:
    
    the static value of TYPES_PATTERN
    
    See Also:
    
    TYPES_PATTERN
  - parserPattern
```
public final java.lang.String parserPattern()
```
    Returns the field parser pattern
    
    Specified by:
    
    parserPattern in interface PatternContainer
    
    Returns:
    
    the static value of PARSER_PATTERN
  - validatorPattern
```
public abstract java.lang.String validatorPattern()
```
    Returns the field validator pattern, that could vary er specific field
    
    Specified by:
    
    validatorPattern in class 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
  - 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
  - getComponentLabels
```
public java.util.List<java.lang.String> getComponentLabels()
```
    Returns english label for components.
    The index in the list is in sync with specific field component structure.
    
    Specified by:
    
    getComponentLabels in class Field
    
    Since:
    
    7.8.4
    
    See Also:
    
    Field.getComponentLabel(int)
  - getComponentMap
```
protected java.util.Map<java.lang.Integer,java.lang.String> getComponentMap()
```
    Returns a mapping between component numbers and their label in camel case format.
    
    Specified by:
    
    getComponentMap in class Field
    
    Since:
    
    7.10.3
  - getName
```
public abstract java.lang.String getName()
```
    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
    
    Returns:
    
    the specific field name (number and letter option)
  - getComponent1
```
public java.lang.String getComponent1()
```
    Gets the component1 (D/C Mark).
    
    Returns:
    
    the component1
  - getDCMark
```
public java.lang.String getDCMark()
```
    Gets the D/C Mark (component1).
    
    Returns:
    
    the D/C Mark from component1
  - getComponent2
```
public java.lang.String getComponent2()
```
    Gets the component2 (Account).
    
    Returns:
    
    the component2
  - getAccount
```
public java.lang.String getAccount()
```
    Gets the Account (component2) removing its starting slashes if any.
    
    Returns:
    
    the Account from component2
  - getComponent3
```
public java.lang.String getComponent3()
```
    Gets the component3 (Name And Address).
    
    Returns:
    
    the component3
  - getNameAndAddressLine1
```
public java.lang.String getNameAndAddressLine1()
```
    Gets the Name And Address (component3).
    
    Returns:
    
    the Name And Address from component3
  - getNameAndAddressLine2
```
public java.lang.String getNameAndAddressLine2()
```
    Gets the Name And Address (component4).
    
    Returns:
    
    the Name And Address from component4
  - getNameAndAddressLine3
```
public java.lang.String getNameAndAddressLine3()
```
    Gets the Name And Address (component5).
    
    Returns:
    
    the Name And Address from component5
  - getNameAndAddressLine4
```
public java.lang.String getNameAndAddressLine4()
```
    Gets the Name And Address (component6).
    
    Returns:
    
    the Name And Address from component6
  - getNameAndAddress
```
public java.lang.String getNameAndAddress()
```
    Gets the Name And Address as a concatenation of component3 to component6.
    
    Returns:
    
    the Name And Address from components
  - getComponent4
```
public java.lang.String getComponent4()
```
    Gets the component4 (Name And Address).
    
    Returns:
    
    the component4
  - getComponent5
```
public java.lang.String getComponent5()
```
    Gets the component5 (Name And Address).
    
    Returns:
    
    the component5
  - getComponent6
```
public java.lang.String getComponent6()
```
    Gets the component6 (Name And Address).
    
    Returns:
    
    the component6
  - getPartyIdentifier
```
public java.lang.String getPartyIdentifier()
```
    Get the formatted Party Identifier (CD Mark + Account) The Party Indentifier has the following format: [/{cd-mark}]/{account}
    
    Specified by:
    
    getPartyIdentifier in interface PartyIdentifier
    
    Returns:
    
    the formatted Party Identifier
  - setPartyIdentifier
```
public OptionDPartyField setPartyIdentifier(java.lang.String partyIdentifier)
```
    Set the formatted Party Identifier (CD Mark + Account) The Party Indentifier has the following format: [/{cd-mark}]/{account} If the format is not valid
    
    Specified by:
    
    setPartyIdentifier in interface PartyIdentifier
    
    Parameters:
    
    partyIdentifier - the formatted Party Identifier to set
    
    Returns:
    
    the current OptionDPartyField

Class OptionDPartyField

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

PARSER_PATTERN

COMPONENTS_PATTERN

TYPES_PATTERN

DC_MARK

ACCOUNT

NAME_AND_ADDRESS

Constructor Detail

OptionDPartyField

OptionDPartyField

Method Detail

parse

getValue

getValueDisplay

componentsPattern

typesPattern

parserPattern

validatorPattern

isOptional

isGeneric

componentsSize

getComponentLabels

getComponentMap

getName

getComponent1

getDCMark

getComponent2

getAccount

getComponent3

getNameAndAddressLine1

getNameAndAddressLine2

getNameAndAddressLine3

getNameAndAddressLine4

getNameAndAddress

getComponent4

getComponent5

getComponent6

getPartyIdentifier

setPartyIdentifier