Field171 (Prowide Integrator API Reference)

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

All Implemented Interfaces:

DateContainer, PatternContainer, Serializable
```
public class Field171
extends Field
implements Serializable, DateContainer
```
Field 171

validation pattern: <DATE2>
parser pattern: S
components pattern: E

Components Data types
- component1: Calendar
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 Integer`	`DATE` Component number for the Date subfield
`static String`	`F_171` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 171
`static String`	`PARSER_PATTERN`

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

Constructor Summary

Constructors
Constructor and Description

Field171()
Default constructor

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

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

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`componentsPattern()`
`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.
`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 Field171`	`get(SwiftMessage msg)` Get the first instance of Field171 in the given message.
`static Field171`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field171>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field171 in the given message an empty list is returned if none found.
`static List<Field171>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field171 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`	`getDate()` Get the Date (component1).
`Calendar`	`getDateAsCalendar()` Get the Date (component1) as Calendar
`String`	`getName()` Deprecated. use constant Field171
`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.
`static Field171`	`newInstance(Field171 source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`String`	`parserPattern()`
`Field171`	`setComponent1(Calendar component1)` Set the component1.
`Field171`	`setComponent1(String component1)` Set the component1.
`Field171`	`setDate(Calendar component1)` Set the Date (component1) as Calendar
`Field171`	`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, getLine, getValueByCodeword, getValueDisplay, hashCode, is, is, is, isAnyOf, 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
  - NAME
```
public static final String NAME
```
    Constant with the field name 171
    
    See Also:
    Constant Field Values
  - F_171
```
public static final String F_171
```
    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
  - DATE
```
public static final Integer DATE
```
    Component number for the Date subfield
- Constructor Detail
  - Field171
```
public Field171()
```
    Default constructor
  - Field171
```
public Field171(String value)
```
    Creates the field parsing the parameter value into fields' components
    
    Parameters:
    value -
- Method Detail
  - newInstance
```
public static Field171 newInstance(Field171 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)
    
    Overrides:
    
    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
  - getComponent1AsCalendar
```
public Calendar getComponent1AsCalendar()
```
    Get the component1 as Calendar
    
    Returns:
    the component1 converted to Calendar or null if cannot be converted
  - 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
  - setComponent1
```
public Field171 setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setComponent1
```
public Field171 setComponent1(Calendar component1)
```
    Set the component1.
    
    Parameters:
    component1 - the Calendar with the component1 content to set
  - setDate
```
public Field171 setDate(String component1)
```
    Set the Date (component1).
    
    Parameters:
    component1 - the Date to set
  - setDate
```
public Field171 setDate(Calendar component1)
```
    Set the Date (component1) as Calendar
    
    Parameters:
    component1 - Calendar with the Date content to set
  - dates
```
public List<Calendar> dates()
```
    Description copied from interface: DateContainer
    
    Get a calendar for every date found
    
    Specified by:
    
    dates in interface DateContainer
  - 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
  - componentsPattern
```
public String componentsPattern()
```
    Specified by:
    
    componentsPattern in interface PatternContainer
  - parserPattern
```
public String parserPattern()
```
    Specified by:
    
    parserPattern in interface PatternContainer
  - getName
```
public String getName()
```
    Deprecated. use constant Field171
    
    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
  - get
```
public static Field171 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 Field171 get(SwiftMessage msg)
```
    Get the first instance of Field171 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<Field171> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field171 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<Field171> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field171 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

Class Field171

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

NAME

F_171

PARSER_PATTERN

COMPONENTS_PATTERN

DATE

Constructor Detail

Field171

Field171

Method Detail

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsCalendar

getDate

getDateAsCalendar

setComponent1

setComponent1

setDate

setDate

dates

isOptional

isGeneric

componentsPattern

parserPattern

getName

get

get

getAll

getAll

componentsSize