Field22C (Prowide Core API Reference)

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

All Implemented Interfaces:

JsonSerializable, PatternContainer, java.io.Serializable
```
@Generated
public class Field22C
extends Field
implements java.io.Serializable
```
SWIFT MT Field 22C.
Model and parser for field 22C of a SWIFT MT message.
Subfields (components) Data types
1. Component 1: PartyPrefix1: String
2. Component 2: PartySuffix1: String
3. Component 3: ReferenceCode: Long
4. Component 4: PartyPrefix2: String
5. Component 5: PartySuffix2: String
Structure definition
- validation pattern: CUSTOM
- parser pattern: 4!S2!S4!S4!S2!S
- components pattern: SSNSS
This class complies with standard release SRU2024
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`F_22C` Same as NAME, intended to be clear when using static imports.
`static java.lang.String`	`NAME` Constant with the field name 22C.
`static java.lang.Integer`	`PARTY_PREFIX_1` Component number for the Party Prefix 1 subfield.
`static java.lang.Integer`	`PARTY_PREFIX_2` Component number for the Party Prefix 2 subfield.
`static java.lang.Integer`	`PARTY_SUFFIX_1` Component number for the Party Suffix 1 subfield.
`static java.lang.Integer`	`PARTY_SUFFIX_2` Component number for the Party Suffix 2 subfield.
`static java.lang.Integer`	`REFERENCE_CODE` Component number for the Reference Code subfield.
`static int`	`SRU` Constant identifying the SRU to which this class belongs to.

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

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`static Field22C`	`fromJson(java.lang.String json)` This method deserializes the JSON data into a Field22C object.
`static Field22C`	`get(SwiftMessage msg)` Gets the first instance of Field22C in the given message.
`static Field22C`	`get(SwiftTagListBlock block)` Gets the first occurrence form the tag list or null if not found.
`static java.util.List<Field22C>`	`getAll(SwiftMessage msg)` Gets a list of all occurrences of the field Field22C in the given message an empty list is returned if none found.
`static java.util.List<Field22C>`	`getAll(SwiftTagListBlock block)` Gets a list of all occurrences of the field Field22C from the given block an empty list is returned if none found.
`java.lang.String`	`getComponent1()` Gets the component 1 (Party Prefix 1).
`java.lang.String`	`getComponent2()` Gets the component 2 (Party Suffix 1).
`java.lang.String`	`getComponent3()` Gets the component 3 (Reference Code).
`java.lang.Long`	`getComponent3AsLong()` Get the component 3 as Long
`java.lang.String`	`getComponent4()` Gets the component 4 (Party Prefix 2).
`java.lang.String`	`getComponent5()` Gets the component 5 (Party Suffix 2).
`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.
`protected java.util.Map<java.lang.String,java.lang.Integer>`	`getLabelMap()` Returns a mapping between component labels and the internal component number.
`java.lang.String`	`getName()` Returns the field's name composed by the field number and the letter option (if any).
`java.lang.String`	`getPartyPrefix1()` Gets the Party Prefix 1 (component 1).
`java.lang.String`	`getPartyPrefix2()` Gets the Party Prefix 2 (component 4).
`java.lang.String`	`getPartySuffix1()` Gets the Party Suffix 1 (component 2).
`java.lang.String`	`getPartySuffix2()` Gets the Party Suffix 2 (component 5).
`java.lang.String`	`getReferenceCode()` Gets the Reference Code (component 3).
`java.lang.Long`	`getReferenceCodeAsLong()` Get the Reference Code (component 3) as Long
`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.
`static Field22C`	`newInstance(Field22C source)` Copy constructor.
`void`	`parse(java.lang.String value)` Parses the parameter value into the internal components structure.
`java.lang.String`	`parserPattern()` Returns the field parser pattern.
`Field22C`	`setComponent1(java.lang.String component1)` Set the component 1 (Party Prefix 1).
`Field22C`	`setComponent2(java.lang.String component2)` Set the component 2 (Party Suffix 1).
`Field22C`	`setComponent3(java.lang.Number component3)` Alternative method setter for field's Reference Code (component 3) as Number
`Field22C`	`setComponent3(java.lang.String component3)` Set the component 3 (Reference Code).
`Field22C`	`setComponent4(java.lang.String component4)` Set the component 4 (Party Prefix 2).
`Field22C`	`setComponent5(java.lang.String component5)` Set the component 5 (Party Suffix 2).
`Field22C`	`setPartyPrefix1(java.lang.String component1)` Set the Party Prefix 1 (component 1).
`Field22C`	`setPartyPrefix2(java.lang.String component4)` Set the Party Prefix 2 (component 4).
`Field22C`	`setPartySuffix1(java.lang.String component2)` Set the Party Suffix 1 (component 2).
`Field22C`	`setPartySuffix2(java.lang.String component5)` Set the Party Suffix 2 (component 5).
`Field22C`	`setReferenceCode(java.lang.Number component3)` Alternative method setter for field's Reference Code (component 3) as Number
`Field22C`	`setReferenceCode(java.lang.String component3)` Set the Reference Code (component 3).
`static Tag`	`tag(java.lang.String value)` Create a Tag with this field name and the given value.
`java.lang.String`	`typesPattern()` Returns the field component types pattern.
`java.lang.String`	`validatorPattern()` Returns the field validator pattern

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

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

- 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 22C.
    
    See Also:
    
    Constant Field Values
  - F_22C
```
public static final java.lang.String F_22C
```
    Same as NAME, intended to be clear when using static imports.
    
    See Also:
    
    Constant Field Values
  - PARTY_PREFIX_1
```
public static final java.lang.Integer PARTY_PREFIX_1
```
    Component number for the Party Prefix 1 subfield.
  - PARTY_SUFFIX_1
```
public static final java.lang.Integer PARTY_SUFFIX_1
```
    Component number for the Party Suffix 1 subfield.
  - REFERENCE_CODE
```
public static final java.lang.Integer REFERENCE_CODE
```
    Component number for the Reference Code subfield.
  - PARTY_PREFIX_2
```
public static final java.lang.Integer PARTY_PREFIX_2
```
    Component number for the Party Prefix 2 subfield.
  - PARTY_SUFFIX_2
```
public static final java.lang.Integer PARTY_SUFFIX_2
```
    Component number for the Party Suffix 2 subfield.
- Constructor Detail
  - Field22C
```
public Field22C()
```
    Default constructor. Creates a new field setting all components to null.
  - Field22C
```
public Field22C(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
  - Field22C
```
public Field22C(Tag tag)
```
    Creates a new field and initializes its components with content from the parameter tag. The value is parsed with parse(String)
    
    Throws:
    
    java.lang.IllegalArgumentException - if the parameter tag is null or its tagname does not match the field name
    
    Since:
    
    7.8
- Method Detail
  - newInstance
```
public static Field22C newInstance(Field22C 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
  - 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
  - typesPattern
```
public 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
    
    Since:
    
    9.2.7
  - parserPattern
```
public java.lang.String parserPattern()
```
    Returns the field parser pattern.
    
    Specified by:
    
    parserPattern in interface PatternContainer
  - validatorPattern
```
public java.lang.String validatorPattern()
```
    Returns the field validator pattern
    
    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
  - getLabelMap
```
protected java.util.Map<java.lang.String,java.lang.Integer> getLabelMap()
```
    Description copied from class: Field
    
    Returns a mapping between component labels and the internal component number. Component labels are in lowercase and without spaces and separators. If a for a given component there is more than one label option, both are mapped to the same component number.
    
    Specified by:
    
    getLabelMap in class Field
    
    Since:
    
    9.3.12
    
    See Also:
    
    Field.getLabelMap()
  - getComponent1
```
public java.lang.String getComponent1()
```
    Gets the component 1 (Party Prefix 1).
    
    Returns:
    
    the component 1
  - getPartyPrefix1
```
public java.lang.String getPartyPrefix1()
```
    Gets the Party Prefix 1 (component 1).
    
    Returns:
    
    the Party Prefix 1 from component 1
  - getComponent2
```
public java.lang.String getComponent2()
```
    Gets the component 2 (Party Suffix 1).
    
    Returns:
    
    the component 2
  - getPartySuffix1
```
public java.lang.String getPartySuffix1()
```
    Gets the Party Suffix 1 (component 2).
    
    Returns:
    
    the Party Suffix 1 from component 2
  - getComponent3
```
public java.lang.String getComponent3()
```
    Gets the component 3 (Reference Code).
    
    Returns:
    
    the component 3
  - getComponent3AsLong
```
public java.lang.Long getComponent3AsLong()
```
    Get the component 3 as Long
    
    Returns:
    
    the component 3 converted to Long or null if cannot be converted
    
    Since:
    
    9.2.7
  - getReferenceCode
```
public java.lang.String getReferenceCode()
```
    Gets the Reference Code (component 3).
    
    Returns:
    
    the Reference Code from component 3
  - getReferenceCodeAsLong
```
public java.lang.Long getReferenceCodeAsLong()
```
    Get the Reference Code (component 3) as Long
    
    Returns:
    
    the Reference Code from component 3 converted to Long or null if cannot be converted
    
    Since:
    
    9.2.7
  - getComponent4
```
public java.lang.String getComponent4()
```
    Gets the component 4 (Party Prefix 2).
    
    Returns:
    
    the component 4
  - getPartyPrefix2
```
public java.lang.String getPartyPrefix2()
```
    Gets the Party Prefix 2 (component 4).
    
    Returns:
    
    the Party Prefix 2 from component 4
  - getComponent5
```
public java.lang.String getComponent5()
```
    Gets the component 5 (Party Suffix 2).
    
    Returns:
    
    the component 5
  - getPartySuffix2
```
public java.lang.String getPartySuffix2()
```
    Gets the Party Suffix 2 (component 5).
    
    Returns:
    
    the Party Suffix 2 from component 5
  - setComponent1
```
public Field22C setComponent1(java.lang.String component1)
```
    Set the component 1 (Party Prefix 1).
    
    Parameters:
    
    component1 - the Party Prefix 1 to set
    
    Returns:
    
    the field object to enable build pattern
  - setPartyPrefix1
```
public Field22C setPartyPrefix1(java.lang.String component1)
```
    Set the Party Prefix 1 (component 1).
    
    Parameters:
    
    component1 - the Party Prefix 1 to set
    
    Returns:
    
    the field object to enable build pattern
  - setComponent2
```
public Field22C setComponent2(java.lang.String component2)
```
    Set the component 2 (Party Suffix 1).
    
    Parameters:
    
    component2 - the Party Suffix 1 to set
    
    Returns:
    
    the field object to enable build pattern
  - setPartySuffix1
```
public Field22C setPartySuffix1(java.lang.String component2)
```
    Set the Party Suffix 1 (component 2).
    
    Parameters:
    
    component2 - the Party Suffix 1 to set
    
    Returns:
    
    the field object to enable build pattern
  - setComponent3
```
public Field22C setComponent3(java.lang.String component3)
```
    Set the component 3 (Reference Code).
    
    Parameters:
    
    component3 - the Reference Code to set
    
    Returns:
    
    the field object to enable build pattern
  - setComponent3
```
public Field22C setComponent3(java.lang.Number component3)
```
    Alternative method setter for field's Reference Code (component 3) as Number
    This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
    
    Parameters:
    
    component3 - the Number with the Reference Code content to set
    
    Returns:
    
    the field object to enable build pattern
  - setReferenceCode
```
public Field22C setReferenceCode(java.lang.String component3)
```
    Set the Reference Code (component 3).
    
    Parameters:
    
    component3 - the Reference Code to set
    
    Returns:
    
    the field object to enable build pattern
  - setReferenceCode
```
public Field22C setReferenceCode(java.lang.Number component3)
```
    Alternative method setter for field's Reference Code (component 3) as Number
    This method supports java constant value boxing for simpler coding styles (ex: 10 becomes an Integer)
    
    Parameters:
    
    component3 - the Number with the Reference Code content to set
    
    Returns:
    
    the field object to enable build pattern
  - setComponent4
```
public Field22C setComponent4(java.lang.String component4)
```
    Set the component 4 (Party Prefix 2).
    
    Parameters:
    
    component4 - the Party Prefix 2 to set
    
    Returns:
    
    the field object to enable build pattern
  - setPartyPrefix2
```
public Field22C setPartyPrefix2(java.lang.String component4)
```
    Set the Party Prefix 2 (component 4).
    
    Parameters:
    
    component4 - the Party Prefix 2 to set
    
    Returns:
    
    the field object to enable build pattern
  - setComponent5
```
public Field22C setComponent5(java.lang.String component5)
```
    Set the component 5 (Party Suffix 2).
    
    Parameters:
    
    component5 - the Party Suffix 2 to set
    
    Returns:
    
    the field object to enable build pattern
  - setPartySuffix2
```
public Field22C setPartySuffix2(java.lang.String component5)
```
    Set the Party Suffix 2 (component 5).
    
    Parameters:
    
    component5 - the Party Suffix 2 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 Field
    
    Returns:
    
    the static value of Field22C.NAME
  - get
```
public static Field22C 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 Field22C get(SwiftMessage msg)
```
    Gets the first instance of Field22C 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<Field22C> getAll(SwiftMessage msg)
```
    Gets a list of all occurrences of the field Field22C 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<Field22C> getAll(SwiftTagListBlock block)
```
    Gets a list of all occurrences of the field Field22C 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
  - fromJson
```
public static Field22C fromJson(java.lang.String json)
```
    This method deserializes the JSON data into a Field22C 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)

Class Field22C

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

SRU

NAME

F_22C

PARTY_PREFIX_1

PARTY_SUFFIX_1

REFERENCE_CODE

PARTY_PREFIX_2

PARTY_SUFFIX_2

Constructor Detail

Field22C

Field22C

Field22C

Method Detail

newInstance

tag

emptyTag

parse

getValue

getValueDisplay

typesPattern

parserPattern

validatorPattern

isOptional

isGeneric

componentsSize

getComponentLabels

getComponentMap

getLabelMap

getComponent1

getPartyPrefix1

getComponent2

getPartySuffix1

getComponent3

getComponent3AsLong

getReferenceCode

getReferenceCodeAsLong

getComponent4

getPartyPrefix2

getComponent5

getPartySuffix2

setComponent1

setPartyPrefix1

setComponent2

setPartySuffix1

setComponent3

setComponent3

setReferenceCode

setReferenceCode

setComponent4

setPartyPrefix2

setComponent5

setPartySuffix2

getName

get

get

getAll

getAll

fromJson