Field30J (Prowide Integrator API Reference)

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

All Implemented Interfaces:

PatternContainer, Serializable
```
@Generated
public class Field30J
extends Field
implements Serializable
```
SWIFT MT Field 30J
Model and parser for field 30J of a SWIFT MT message.
Subfields (components) Data types
1. String
2. Number
Structure definition
- validation pattern: 1!a3!n
- parser pattern: SN
- components pattern: SN
This class complies with standard release SRU2017

NOTE: this source code has been generated from template
See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENTS_PATTERN`
`static String`	`F_30J` same as NAME, intended to be clear when using static imports
`static Integer`	`INDICATOR` Component number for the Indicator subfield
`static String`	`NAME` Constant with the field name 30J
`static Integer`	`NUMBER` Component number for the Number subfield
`static String`	`PARSER_PATTERN`
`static int`	`SRU` Constant identifying the SRU to which this class belongs to.

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

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`componentsPattern()` Returns the field's components pattern
`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 Field30J`	`get(SwiftMessage msg)` Get the first instance of Field30J in the given message.
`static Field30J`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field30J>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field30J in the given message an empty list is returned if none found.
`static List<Field30J>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field30J from the given block an empty list is returned if none found.
`String`	`getComponent1()` Get the component1
`String`	`getComponent1AsString()` Deprecated. use `Field.getComponent(int)` instead
`String`	`getComponent2()` Get the component2
`Number`	`getComponent2AsNumber()` Get the component2 as Number
`protected List<String>`	`getComponentLabels()` Returns english label for components.
`String`	`getIndicator()` Get the Indicator (component1).
`String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`String`	`getNumber()` Get the Number (component2).
`Number`	`getNumberAsNumber()` Get the Number (component2) as Number
`String`	`getValue()` Serializes the fields' components into the single string value (SWIFT format)
`String`	`getValueDisplay(int component, 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 Field30J`	`newInstance(Field30J source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`void`	`parse(String value)` Parses the parameter value into the internal components structure.
`String`	`parserPattern()`
`Field30J`	`setComponent1(String component1)` Set the component1.
`Field30J`	`setComponent2(Number component2)` Set the component2 from a Number object.
`Field30J`	`setComponent2(String component2)` Set the component2.
`Field30J`	`setIndicator(String component1)` Set the Indicator (component1).
`Field30J`	`setNumber(Number component2)` Set the Number (component2) from a Number object.
`Field30J`	`setNumber(String component2)` Set the Number (component2).
`static Tag`	`tag(String value)` Create a Tag with this field name and the given value.
`String`	`validatorPattern()` Returns the field's validators pattern

Methods inherited from class com.prowidesoftware.swift.model.field.Field
append, appendInLines, appendInLines, asTag, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabel, getLabel, getLabel, getLabelComponents, getLine, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, init, is, is, is, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, notNull, setComponent, setComponents, 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 String NAME
```
    Constant with the field name 30J
    
    See Also:
    Constant Field Values
  - F_30J
```
public static final String F_30J
```
    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
  - INDICATOR
```
public static final Integer INDICATOR
```
    Component number for the Indicator subfield
  - NUMBER
```
public static final Integer NUMBER
```
    Component number for the Number subfield
- Constructor Detail
  - Field30J
```
public Field30J()
```
    Default constructor. Creates a new field setting all components to null.
  - Field30J
```
public Field30J(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
  - Field30J
```
public Field30J(Tag tag)
```
    Creates a new field and initializes its components with content from the parameter tag. The value is parsed with parse(String)
    
    Throws:
    
    IllegalArgumentException - if the parameter tag is null or its tagname does not match the field name
    Since:
    
    7.8
- Method Detail
  - parse
```
public void parse(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
  - newInstance
```
public static Field30J newInstance(Field30J 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)
    
    Specified by:
    
    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
@ProwideDeprecated(phase2=_2018)
public String getComponent1AsString()
```
    Deprecated. use Field.getComponent(int) instead
    
    Same as getComponent(1)
  - getIndicator
```
public String getIndicator()
```
    Get the Indicator (component1).
    
    Returns:
    the Indicator from component1
  - setComponent1
```
public Field30J setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setIndicator
```
public Field30J setIndicator(String component1)
```
    Set the Indicator (component1).
    
    Parameters:
    component1 - the Indicator to set
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsNumber
```
public Number getComponent2AsNumber()
```
    Get the component2 as Number
    
    Returns:
    the component2 converted to Number or null if cannot be converted
  - getNumber
```
public String getNumber()
```
    Get the Number (component2).
    
    Returns:
    the Number from component2
  - getNumberAsNumber
```
public Number getNumberAsNumber()
```
    Get the Number (component2) as Number
    
    Returns:
    the Number from component2 converted to Number or null if cannot be converted
  - setComponent2
```
public Field30J setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setComponent2
```
public Field30J setComponent2(Number component2)
```
    Set the component2 from a Number object.
    If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent2(String) method.
    
    Parameters:
    component2 - the Number with the component2 content to set
    See Also:
    setComponent2(String)
  - setNumber
```
public Field30J setNumber(String component2)
```
    Set the Number (component2).
    
    Parameters:
    component2 - the Number to set
  - setNumber
```
public Field30J setNumber(Number component2)
```
    Set the Number (component2) from a Number object.
    
    Parameters:
    component2 - Number with the Number content to set
    See Also:
    setComponent2(java.lang.Number)
  - 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
  - parserPattern
```
public String parserPattern()
```
    Specified by:
    
    parserPattern in interface PatternContainer
  - getName
```
public 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 Field30J.NAME
  - componentsPattern
```
public final String componentsPattern()
```
    Returns the field's components pattern
    
    Specified by:
    
    componentsPattern in interface PatternContainer
    
    Specified by:
    
    componentsPattern in class Field
    
    Returns:
    the static value of Field30J.COMPONENTS_PATTERN
  - validatorPattern
```
public final String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field30J 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 Field30J get(SwiftMessage msg)
```
    Get the first instance of Field30J 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<Field30J> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field30J 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<Field30J> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field30J 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
  - getValueDisplay
```
public String getValueDisplay(int component,
                     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:
    
    IllegalArgumentException - if component number is invalid for the field
    Since:
    
    7.8
  - getComponentLabels
```
protected List<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)

Class Field30J

SWIFT MT Field 30J

Subfields (components) Data types

Structure definition

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_30J

PARSER_PATTERN

COMPONENTS_PATTERN

INDICATOR

NUMBER

Constructor Detail

Field30J

Field30J

Field30J

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsString

getIndicator

setComponent1

setIndicator

getComponent2

getComponent2AsNumber

getNumber

getNumberAsNumber

setComponent2

setComponent2

setNumber

setNumber

isOptional

isGeneric

parserPattern

getName

componentsPattern

validatorPattern

get

get

getAll

getAll

componentsSize

getValueDisplay

getComponentLabels