Field31E (Prowide Core API Reference)

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

All Implemented Interfaces:

JsonSerializable, DateContainer, PatternContainer, java.io.Serializable
```
@Generated
public class Field31E
extends Field
implements java.io.Serializable, DateContainer
```
SWIFT MT Field 31E
Model and parser for field 31E of a SWIFT MT message.
Subfields (components) Data types
1. Calendar
Structure definition
- validation pattern: <DATE2>
- parser pattern: S
- components pattern: E
This class complies with standard release SRU2019
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENTS_PATTERN`
`static java.lang.Integer`	`DATE` Component number for the Date subfield
`static java.lang.String`	`F_31E` same as NAME, intended to be clear when using static imports
`static java.lang.String`	`NAME` Constant with the field name 31E
`static java.lang.String`	`PARSER_PATTERN`
`static int`	`SRU` Constant identifying the SRU to which this class belongs to.

Constructor Summary

Constructors
Constructor and Description
`Field31E()` Default constructor.
`Field31E(java.lang.String value)` Creates a new field and initializes its components with content from the parameter value.
`Field31E(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
`java.lang.String`	`componentsPattern()` Returns the field 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.
`java.util.List<java.util.Calendar>`	`dates()` Get a calendar for every date found
`static Tag`	`emptyTag()` Create a Tag with this field name and an empty string as value Shorthand for `new Tag(NAME, "")`
`static Field31E`	`fromJson(java.lang.String json)` This method deserializes the JSON data into a Field31E object.
`static Field31E`	`get(SwiftMessage msg)` Gets the first instance of Field31E in the given message.
`static Field31E`	`get(SwiftTagListBlock block)` Gets the first occurrence form the tag list or null if not found.
`static java.util.List<Field31E>`	`getAll(SwiftMessage msg)` Gets a list of all occurrences of the field Field31E in the given message an empty list is returned if none found.
`static java.util.List<Field31E>`	`getAll(SwiftTagListBlock block)` Gets a list of all occurrences of the field Field31E from the given block an empty list is returned if none found.
`java.lang.String`	`getComponent1()` Gets the component1 (Date).
`java.util.Calendar`	`getComponent1AsCalendar()` Get the component1 as Calendar
`java.lang.String`	`getDate()` Gets the Date (component1).
`java.util.Calendar`	`getDateAsCalendar()` Get the Date (component1) as Calendar
`java.lang.String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`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 Field31E`	`newInstance(Field31E source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`void`	`parse(java.lang.String value)` Parses the parameter value into the internal components structure.
`java.lang.String`	`parserPattern()` Returns the field parser pattern
`Field31E`	`setComponent1(java.util.Calendar component1)` Set the component1 from a Calendar object.
`Field31E`	`setComponent1(java.lang.String component1)` Set the component1 (Date).
`Field31E`	`setDate(java.util.Calendar component1)` Set the Date (component1) from a Calendar object.
`Field31E`	`setDate(java.lang.String component1)` Set the Date (component1).
`static Tag`	`tag(java.lang.String value)` Create a Tag with this field name and the given value.
`java.lang.String`	`validatorPattern()` Returns the field validator pattern

Methods inherited from class com.prowidesoftware.swift.model.field.Field
asTag, equals, findComponentStartingWith, getAsBigDecimal, getComponent, getComponentAs, getComponentAsNumber, getComponentLabel, getComponents, getConditionalQualifier, getDSS, getField, getField, getLabel, getLabel, getLabelComponents, getValueByCodeword, getValueDisplay, getValueDisplay, hashCode, is, is, is, is, isAnyOf, isDSSPresent, isEmpty, isLetterOption, isNameAnyOf, joinComponents, joinComponents, joinComponents, joinComponents, letterOption, setComponent, setComponents, toJson, toString, validName

Methods inherited from class java.lang.Object
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 31E
    
    See Also:
    
    Constant Field Values
  - F_31E
```
public static final java.lang.String F_31E
```
    same as NAME, intended to be clear when using static imports
    
    See Also:
    
    Constant Field Values
  - PARSER_PATTERN
```
public static final java.lang.String PARSER_PATTERN
```
    See Also:
    
    Constant Field Values
  - COMPONENTS_PATTERN
```
public static final java.lang.String COMPONENTS_PATTERN
```
    See Also:
    
    Constant Field Values
  - DATE
```
public static final java.lang.Integer DATE
```
    Component number for the Date subfield
- Constructor Detail
  - Field31E
```
public Field31E()
```
    Default constructor. Creates a new field setting all components to null.
  - Field31E
```
public Field31E(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
  - Field31E
```
public Field31E(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 Field31E newInstance(Field31E 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
  - componentsPattern
```
public final java.lang.String componentsPattern()
```
    Returns the field components pattern
    
    Specified by:
    
    componentsPattern in interface PatternContainer
    
    Specified by:
    
    componentsPattern in class Field
    
    Returns:
    
    the static value of Field31E.COMPONENTS_PATTERN
  - parserPattern
```
public final java.lang.String parserPattern()
```
    Returns the field parser pattern
    
    Specified by:
    
    parserPattern in interface PatternContainer
    
    Returns:
    
    the static value of Field31E.PARSER_PATTERN
  - validatorPattern
```
public final 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
  - getComponent1
```
public java.lang.String getComponent1()
```
    Gets the component1 (Date).
    
    Returns:
    
    the component1
  - getComponent1AsCalendar
```
public java.util.Calendar getComponent1AsCalendar()
```
    Get the component1 as Calendar
    
    Returns:
    
    the component1 converted to Calendar or null if cannot be converted
  - getDate
```
public java.lang.String getDate()
```
    Gets the Date (component1).
    
    Returns:
    
    the Date from component1
  - getDateAsCalendar
```
public java.util.Calendar getDateAsCalendar()
```
    Get the Date (component1) as Calendar
    
    Returns:
    
    the Date from component1 converted to Calendar or null if cannot be converted
  - dates
```
public java.util.List<java.util.Calendar> dates()
```
    Description copied from interface: DateContainer
    
    Get a calendar for every date found
    
    Specified by:
    
    dates in interface DateContainer
  - setComponent1
```
public Field31E setComponent1(java.lang.String component1)
```
    Set the component1 (Date).
    
    Parameters:
    
    component1 - the component1 to set
  - setComponent1
```
public Field31E setComponent1(java.util.Calendar component1)
```
    Set the component1 from a Calendar object.
    
    Parameters:
    
    component1 - the Calendar with the component1 content to set
  - setDate
```
public Field31E setDate(java.lang.String component1)
```
    Set the Date (component1).
    
    Parameters:
    
    component1 - the Date to set
  - setDate
```
public Field31E setDate(java.util.Calendar component1)
```
    Set the Date (component1) from a Calendar object.
    
    Parameters:
    
    component1 - Calendar with the Date content to set
    
    See Also:
    
    setComponent1(java.util.Calendar)
  - 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 Field31E.NAME
  - get
```
public static Field31E 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 Field31E get(SwiftMessage msg)
```
    Gets the first instance of Field31E 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<Field31E> getAll(SwiftMessage msg)
```
    Gets a list of all occurrences of the field Field31E 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<Field31E> getAll(SwiftTagListBlock block)
```
    Gets a list of all occurrences of the field Field31E 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 Field31E fromJson(java.lang.String json)
```
    This method deserializes the JSON data into a Field31E 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 Field31E

Field Summary

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_31E

PARSER_PATTERN

COMPONENTS_PATTERN

DATE

Constructor Detail

Field31E

Field31E

Field31E

Method Detail

newInstance

tag

emptyTag

parse

getValue

getValueDisplay

componentsPattern

parserPattern

validatorPattern

isOptional

isGeneric

componentsSize

getComponent1

getComponent1AsCalendar

getDate

getDateAsCalendar

dates

setComponent1

setComponent1

setDate

setDate

getName

get

get

getAll

getAll

fromJson