Field77H (Prowide Integrator API Reference)

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

All Implemented Interfaces:

DateContainer, MultiLineField, PatternContainer, Serializable
```
public class Field77H
extends Field
implements Serializable, DateContainer, MultiLineField
```
Field 77H

validation pattern: 6a[/<DATE4>][//<YEAR>]
parser pattern: S[/S][//S]
components pattern: SDY

Components Data types
- component1: String
- component2: Calendar
- component3: 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_77H` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 77H
`static String`	`PARSER_PATTERN`
`static Integer`	`TYPE_OF_AGREEMENT` Component number for the Type Of Agreement subfield
`static Integer`	`VERSION` Component number for the Version subfield

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

Constructor Summary

Constructors
Constructor and Description

Field77H()
Default constructor

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

Constructors
Constructor and Description
`Field77H()` Default constructor
`Field77H(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 Field77H`	`get(SwiftMessage msg)` Get the first instance of Field77H in the given message.
`static Field77H`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field77H>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field77H in the given message an empty list is returned if none found.
`static List<Field77H>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field77H from the given block an empty list is returned if none found.
`String`	`getComponent1()` Get the component1
`String`	`getComponent1AsString()` Deprecated.
`String`	`getComponent2()` Get the component2
`Calendar`	`getComponent2AsCalendar()` Get the component2 as Calendar
`String`	`getComponent3()` Get the component3
`Calendar`	`getComponent3AsCalendar()` Get the component3 as Calendar
`String`	`getDate()` Get the Date (component2).
`Calendar`	`getDateAsCalendar()` Get the Date (component2) as Calendar
`String`	`getLine(int line)` Returns a specific line from the field's value.
`String`	`getLine(int line, int offset)` Returns a specific line from the field's value.
`List<String>`	`getLines()` Returns the field value split into lines.
`List<String>`	`getLines(int offset)` Returns the field value starting at the offset component, split into lines.
`List<String>`	`getLinesBetween(int start, int end)` Returns a specific subset of lines from the field's value, given a range.
`List<String>`	`getLinesBetween(int start, int end, int offset)` Returns a specific subset of lines from the field's value, starting at the offset component.
`String`	`getName()` Deprecated. use constant Field77H
`String`	`getTypeOfAgreement()` Get the Type Of Agreement (component1).
`String`	`getValue()` Serializes the fields' components into the single string value (SWIFT format)
`String`	`getVersion()` Get the Version (component3).
`Calendar`	`getVersionAsCalendar()` Get the Version (component3) as Calendar
`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 Field77H`	`newInstance(Field77H source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`String`	`parserPattern()`
`Field77H`	`setComponent1(String component1)` Set the component1.
`Field77H`	`setComponent2(Calendar component2)` Set the component2.
`Field77H`	`setComponent2(String component2)` Set the component2.
`Field77H`	`setComponent3(Calendar component3)` Set the component3.
`Field77H`	`setComponent3(String component3)` Set the component3.
`Field77H`	`setDate(Calendar component2)` Set the Date (component2) as Calendar
`Field77H`	`setDate(String component2)` Set the Date (component2).
`Field77H`	`setTypeOfAgreement(String component1)` Set the Type Of Agreement (component1).
`Field77H`	`setVersion(Calendar component3)` Set the Version (component3) as Calendar
`Field77H`	`setVersion(String component3)` Set the Version (component3).
`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 77H
    
    See Also:
    Constant Field Values
  - F_77H
```
public static final String F_77H
```
    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
  - TYPE_OF_AGREEMENT
```
public static final Integer TYPE_OF_AGREEMENT
```
    Component number for the Type Of Agreement subfield
  - DATE
```
public static final Integer DATE
```
    Component number for the Date subfield
  - VERSION
```
public static final Integer VERSION
```
    Component number for the Version subfield
- Constructor Detail
  - Field77H
```
public Field77H()
```
    Default constructor
  - Field77H
```
public Field77H(String value)
```
    Creates the field parsing the parameter value into fields' components
    
    Parameters:
    value -
- Method Detail
  - newInstance
```
public static Field77H newInstance(Field77H 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
  - getComponent1AsString
```
@Deprecated
public String getComponent1AsString()
```
    Deprecated.
    
    Same as getComponent(1)
  - getTypeOfAgreement
```
public String getTypeOfAgreement()
```
    Get the Type Of Agreement (component1).
    
    Returns:
    the Type Of Agreement from component1
  - setComponent1
```
public Field77H setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setTypeOfAgreement
```
public Field77H setTypeOfAgreement(String component1)
```
    Set the Type Of Agreement (component1).
    
    Parameters:
    component1 - the Type Of Agreement to set
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsCalendar
```
public Calendar getComponent2AsCalendar()
```
    Get the component2 as Calendar
    
    Returns:
    the component2 converted to Calendar or null if cannot be converted
  - getDate
```
public String getDate()
```
    Get the Date (component2).
    
    Returns:
    the Date from component2
  - getDateAsCalendar
```
public Calendar getDateAsCalendar()
```
    Get the Date (component2) as Calendar
    
    Returns:
    the Date from component2 converted to Calendar or null if cannot be converted
  - setComponent2
```
public Field77H setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setComponent2
```
public Field77H setComponent2(Calendar component2)
```
    Set the component2.
    
    Parameters:
    component2 - the Calendar with the component2 content to set
  - setDate
```
public Field77H setDate(String component2)
```
    Set the Date (component2).
    
    Parameters:
    component2 - the Date to set
  - setDate
```
public Field77H setDate(Calendar component2)
```
    Set the Date (component2) as Calendar
    
    Parameters:
    component2 - Calendar with the Date content to set
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsCalendar
```
public Calendar getComponent3AsCalendar()
```
    Get the component3 as Calendar
    
    Returns:
    the component3 converted to Calendar or null if cannot be converted
  - getVersion
```
public String getVersion()
```
    Get the Version (component3).
    
    Returns:
    the Version from component3
  - getVersionAsCalendar
```
public Calendar getVersionAsCalendar()
```
    Get the Version (component3) as Calendar
    
    Returns:
    the Version from component3 converted to Calendar or null if cannot be converted
  - setComponent3
```
public Field77H setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setComponent3
```
public Field77H setComponent3(Calendar component3)
```
    Set the component3.
    
    Parameters:
    component3 - the Calendar with the component3 content to set
  - setVersion
```
public Field77H setVersion(String component3)
```
    Set the Version (component3).
    
    Parameters:
    component3 - the Version to set
  - setVersion
```
public Field77H setVersion(Calendar component3)
```
    Set the Version (component3) as Calendar
    
    Parameters:
    component3 - Calendar with the Version 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 Field77H
    
    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 Field77H 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 Field77H get(SwiftMessage msg)
```
    Get the first instance of Field77H 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<Field77H> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field77H 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<Field77H> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field77H 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
  - getLine
```
public String getLine(int line)
```
    Returns a specific line from the field's value.
    
    Specified by:
    
    getLine in interface MultiLineField
    
    Parameters:
    line - a reference to a specific line in the field, first line being 1
    
    Returns:
    line content or null if not present or if line number is above the expected
    Since:
    
    7.7
    
    See Also:
    MultiLineField#getLine(int)}
  - getLine
```
public String getLine(int line,
             int offset)
```
    Returns a specific line from the field's value.
    
    Specified by:
    
    getLine in interface MultiLineField
    
    Parameters:
    line - a reference to a specific line in the field, first line being 1
    offset - an optional component number used as offset when counting lines
    
    Returns:
    line content or null if not present or if line number is above the expected
    Since:
    
    7.7
    
    See Also:
    MultiLineField#getLine(int, int)}
  - getLines
```
public List<String> getLines()
```
    Returns the field value split into lines.
    
    Specified by:
    
    getLines in interface MultiLineField
    
    Returns:
    lines content or empty list if field's value is empty
    Since:
    
    7.7
    
    See Also:
    MultiLineField#getLines()}
  - getLines
```
public List<String> getLines(int offset)
```
    Returns the field value starting at the offset component, split into lines.
    
    Specified by:
    
    getLines in interface MultiLineField
    
    Parameters:
    offset - an optional component number used as offset when counting lines
    
    Returns:
    found lines or empty list if lines are not present or the offset is invalid
    Since:
    
    7.7
    
    See Also:
    MultiLineField#getLines(int offset)}
  - getLinesBetween
```
public List<String> getLinesBetween(int start,
                           int end)
```
    Returns a specific subset of lines from the field's value, given a range.
    
    Specified by:
    
    getLinesBetween in interface MultiLineField
    
    Parameters:
    start - a reference to a specific line in the field, first line being 1
    end - a reference to a specific line in the field, must be greater than start
    
    Returns:
    found lines or empty list if value is empty
    Since:
    
    7.7
    
    See Also:
    MultiLineField#getLinesBetween(int start, int end)}
  - getLinesBetween
```
public List<String> getLinesBetween(int start,
                           int end,
                           int offset)
```
    Returns a specific subset of lines from the field's value, starting at the offset component.
    
    Specified by:
    
    getLinesBetween in interface MultiLineField
    
    Parameters:
    start - a reference to a specific line in the field, first line being 1
    end - a reference to a specific line in the field, must be greater than start
    offset - an optional component number used as offset when counting lines
    
    Returns:
    found lines or empty list if lines are not present or the offset is invalid
    Since:
    
    7.7
    
    See Also:
    MultiLineField#getLinesBetween(int start, int end, int offset)}

Class Field77H

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_77H

PARSER_PATTERN

COMPONENTS_PATTERN

TYPE_OF_AGREEMENT

DATE

VERSION

Constructor Detail

Field77H

Field77H

Method Detail

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsString

getTypeOfAgreement

setComponent1

setTypeOfAgreement

getComponent2

getComponent2AsCalendar

getDate

getDateAsCalendar

setComponent2

setComponent2

setDate

setDate

getComponent3

getComponent3AsCalendar

getVersion

getVersionAsCalendar

setComponent3

setComponent3

setVersion

setVersion

dates

isOptional

isGeneric

componentsPattern

parserPattern

getName

get

get

getAll

getAll

componentsSize

getLine

getLine

getLines

getLines

getLinesBetween

getLinesBetween