Field31D

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

All Implemented Interfaces:

DateContainer, PatternContainer, Serializable
```
public class Field31D
extends Field
implements Serializable, DateContainer
```
Field 31D

validation pattern: <DATE2>29x
parser pattern: <DATE2>S
components pattern: ES

Components Data types
- component1: Calendar
- component2: String
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 String`	`COMPONENTS_PATTERN`
`static String`	`F_31D` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 31D
`static String`	`PARSER_PATTERN`

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

Constructor Summary

Constructors
Constructor and Description

Field31D()
Default constructor

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

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

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`componentsPattern()`
`List<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 Field31D`	`get(SwiftMessage msg)` Get the first instance of Field31D in the given message.
`static Field31D`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field31D>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field31D in the given message an empty list is returned if none found.
`static List<Field31D>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field31D from the given block an empty list is returned if none found.
`String`	`getComponent1()` Get the component1
`Calendar`	`getComponent1AsCalendar()` Get the component1 as Calendar
`String`	`getComponent2()` Get the component2
`String`	`getComponent2AsString()` Deprecated.
`String`	`getDate()` Get the Date (component1).
`Calendar`	`getDateAsCalendar()` Get the Date (component1) as Calendar
`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.
`String`	`parserPattern()`
`Field31D`	`setComponent1(Calendar component1)` Set the component1.
`Field31D`	`setComponent1(String component1)` Set the component1.
`Field31D`	`setComponent2(String component2)` Set the component2.
`Field31D`	`setDate(Calendar component1)` Set the Date (component1) as Calendar
`Field31D`	`setDate(String component1)` Set the Date (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, getName, getValueByCodeword, getValueDisplay, hashCode, is, is, is, 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
  - COMPONENTS_PATTERN
```
public static final String COMPONENTS_PATTERN
```
    See Also:
    Constant Field Values
  - F_31D
```
public static final String F_31D
```
    same as NAME, intended to be clear when using static imports
    
    See Also:
    Constant Field Values
  - NAME
```
public static final String NAME
```
    Constant with the field name 31D
    
    See Also:
    Constant Field Values
  - PARSER_PATTERN
```
public static final String PARSER_PATTERN
```
    See Also:
    Constant Field Values
- Constructor Detail
  - Field31D
```
public Field31D()
```
    Default constructor
  - Field31D
```
public Field31D(String value)
```
    Creates the field parsing the parameter value into fields' components
    
    Parameters:
    value -
- Method Detail
  - componentsPattern
```
public String componentsPattern()
```
    Specified by:
    
    componentsPattern in interface PatternContainer
  - dates
```
public List<Calendar> dates()
```
    Description copied from interface: DateContainer
    
    Get a calendar for every date found
    
    Specified by:
    
    dates in interface DateContainer
  - 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
  - get
```
public static Field31D get(SwiftMessage msg)
```
    Get the first instance of Field31D 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)
  - get
```
public static Field31D 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
  - getAll
```
public static List<Field31D> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field31D 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<Field31D> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field31D 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
  - getComponent1
```
public String getComponent1()
```
    Get the component1
    
    Returns:
    the component1
  - getComponent1AsCalendar
```
public Calendar getComponent1AsCalendar()
```
    Get the component1 as Calendar
    
    Returns:
    the component1 converted to Calendar or null if cannot be converted
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsString
```
@Deprecated
public String getComponent2AsString()
```
    Deprecated.
    
    Same as getComponent(2)
  - getDate
```
public String getDate()
```
    Get the Date (component1).
    
    Returns:
    the Date from component1
  - getDateAsCalendar
```
public Calendar getDateAsCalendar()
```
    Get the Date (component1) as Calendar
    
    Returns:
    the Date from component1 converted to Calendar or null if cannot be converted
  - getValue
```
public String getValue()
```
    Serializes the fields' components into the single string value (SWIFT format)
    
    Overrides:
    
    getValue in class Field
    
    Returns:
    SWIFT formatted value
  - 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
  - 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
  - parserPattern
```
public String parserPattern()
```
    Specified by:
    
    parserPattern in interface PatternContainer
  - setComponent1
```
public Field31D setComponent1(Calendar component1)
```
    Set the component1.
    
    Parameters:
    component1 - the Calendar with the component1 content to set
  - setComponent1
```
public Field31D setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setComponent2
```
public Field31D setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setDate
```
public Field31D setDate(Calendar component1)
```
    Set the Date (component1) as Calendar
    
    Parameters:
    component1 - Calendar with the Date content to set
  - setDate
```
public Field31D setDate(String component1)
```
    Set the Date (component1).
    
    Parameters:
    component1 - the Date to set
  - 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

Class Field31D

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

COMPONENTS_PATTERN

F_31D

NAME

PARSER_PATTERN

Constructor Detail

Field31D

Field31D

Method Detail

componentsPattern

dates

emptyTag

get

get

getAll

getAll

getComponent1

getComponent1AsCalendar

getComponent2

getComponent2AsString

getDate

getDateAsCalendar

getValue

isGeneric

isOptional

parserPattern

setComponent1

setComponent1

setComponent2

setDate

setDate

tag