Field255 (Prowide Integrator API Reference)

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

All Implemented Interfaces:

BICContainer, DateContainer, PatternContainer, Serializable
```
public class Field255
extends Field
implements Serializable, DateContainer, BICContainer
```
Field 255

validation pattern: <SWIFTBIC>|<NON-SWIFTBIC>4!n3!n<DATE2>[<HHMM><HHMM>]
parser pattern: S4!N3!N<DATE2>[<HHMM><HHMM>]
components pattern: BNNEHH

Components Data types
- component1: BIC
- component2: Number
- component3: Number
- component4: Calendar
- component5: Calendar
- component6: 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 Integer`	`BIC` Component number for the BIC subfield
`static String`	`COMPONENTS_PATTERN`
`static Integer`	`DATE` Component number for the Date subfield
`static Integer`	`END_TIME` Component number for the End Time subfield
`static String`	`F_255` same as NAME, intended to be clear when using static imports
`static Integer`	`MESSAGE_TYPE` Component number for the Message Type subfield
`static String`	`NAME` Constant with the field name 255
`static String`	`PARSER_PATTERN`
`static Integer`	`SESSION_NUMBER` Component number for the Session Number subfield
`static Integer`	`START_TIME` Component number for the Start Time subfield

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

Constructor Summary

Constructors
Constructor and Description

Field255()
Default constructor

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

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

Method Summary

Methods
Modifier and Type	Method and Description
`List<BIC>`	`bics()` Utility method that creates a BIC for every string returned by `BICContainer.bicStrings()`
`List<String>`	`bicStrings()` Get a list of strings of BICs present in this field
`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 Field255`	`get(SwiftMessage msg)` Get the first instance of Field255 in the given message.
`static Field255`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field255>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field255 in the given message an empty list is returned if none found.
`static List<Field255>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field255 from the given block an empty list is returned if none found.
`String`	`getBIC()` Get the BIC (component1).
`BIC`	`getBICAsBIC()` Get the BIC (component1) as BIC
`String`	`getComponent1()` Get the component1
`BIC`	`getComponent1AsBIC()` Get the component1 as BIC
`String`	`getComponent2()` Get the component2
`Number`	`getComponent2AsNumber()` Get the component2 as Number
`String`	`getComponent3()` Get the component3
`Number`	`getComponent3AsNumber()` Get the component3 as Number
`String`	`getComponent4()` Get the component4
`Calendar`	`getComponent4AsCalendar()` Get the component4 as Calendar
`String`	`getComponent5()` Get the component5
`Calendar`	`getComponent5AsCalendar()` Get the component5 as Calendar
`String`	`getComponent6()` Get the component6
`Calendar`	`getComponent6AsCalendar()` Get the component6 as Calendar
`String`	`getDate()` Get the Date (component4).
`Calendar`	`getDateAsCalendar()` Get the Date (component4) as Calendar
`String`	`getEndTime()` Get the End Time (component6).
`Calendar`	`getEndTimeAsCalendar()` Get the End Time (component6) as Calendar
`String`	`getMessageType()` Get the Message Type (component3).
`Number`	`getMessageTypeAsNumber()` Get the Message Type (component3) as Number
`String`	`getName()` Deprecated. use constant Field255
`String`	`getSessionNumber()` Get the Session Number (component2).
`Number`	`getSessionNumberAsNumber()` Get the Session Number (component2) as Number
`String`	`getStartTime()` Get the Start Time (component5).
`Calendar`	`getStartTimeAsCalendar()` Get the Start Time (component5) 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.
`static Field255`	`newInstance(Field255 source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`String`	`parserPattern()`
`Field255`	`setBIC(BIC component1)` Set the BIC (component1) as BIC
`Field255`	`setBIC(String component1)` Set the BIC (component1).
`Field255`	`setComponent1(BIC component1)` Set the component1.
`Field255`	`setComponent1(String component1)` Set the component1.
`Field255`	`setComponent2(Number component2)` Set the component2.
`Field255`	`setComponent2(String component2)` Set the component2.
`Field255`	`setComponent3(Number component3)` Set the component3.
`Field255`	`setComponent3(String component3)` Set the component3.
`Field255`	`setComponent4(Calendar component4)` Set the component4.
`Field255`	`setComponent4(String component4)` Set the component4.
`Field255`	`setComponent5(Calendar component5)` Set the component5.
`Field255`	`setComponent5(String component5)` Set the component5.
`Field255`	`setComponent6(Calendar component6)` Set the component6.
`Field255`	`setComponent6(String component6)` Set the component6.
`Field255`	`setDate(Calendar component4)` Set the Date (component4) as Calendar
`Field255`	`setDate(String component4)` Set the Date (component4).
`Field255`	`setEndTime(Calendar component6)` Set the End Time (component6) as Calendar
`Field255`	`setEndTime(String component6)` Set the End Time (component6).
`Field255`	`setMessageType(Number component3)` Set the Message Type (component3) as Number
`Field255`	`setMessageType(String component3)` Set the Message Type (component3).
`Field255`	`setSessionNumber(Number component2)` Set the Session Number (component2) as Number
`Field255`	`setSessionNumber(String component2)` Set the Session Number (component2).
`Field255`	`setStartTime(Calendar component5)` Set the Start Time (component5) as Calendar
`Field255`	`setStartTime(String component5)` Set the Start Time (component5).
`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 255
    
    See Also:
    Constant Field Values
  - F_255
```
public static final String F_255
```
    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
  - BIC
```
public static final Integer BIC
```
    Component number for the BIC subfield
  - SESSION_NUMBER
```
public static final Integer SESSION_NUMBER
```
    Component number for the Session Number subfield
  - MESSAGE_TYPE
```
public static final Integer MESSAGE_TYPE
```
    Component number for the Message Type subfield
  - DATE
```
public static final Integer DATE
```
    Component number for the Date subfield
  - START_TIME
```
public static final Integer START_TIME
```
    Component number for the Start Time subfield
  - END_TIME
```
public static final Integer END_TIME
```
    Component number for the End Time subfield
- Constructor Detail
  - Field255
```
public Field255()
```
    Default constructor
  - Field255
```
public Field255(String value)
```
    Creates the field parsing the parameter value into fields' components
    
    Parameters:
    value -
- Method Detail
  - newInstance
```
public static Field255 newInstance(Field255 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
  - getComponent1AsBIC
```
public BIC getComponent1AsBIC()
```
    Get the component1 as BIC
    
    Returns:
    the component1 converted to BIC or null if cannot be converted
  - getBIC
```
public String getBIC()
```
    Get the BIC (component1).
    
    Returns:
    the BIC from component1
  - getBICAsBIC
```
public BIC getBICAsBIC()
```
    Get the BIC (component1) as BIC
    
    Returns:
    the BIC from component1 converted to BIC or null if cannot be converted
  - setComponent1
```
public Field255 setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setComponent1
```
public Field255 setComponent1(BIC component1)
```
    Set the component1.
    
    Parameters:
    component1 - the BIC with the component1 content to set
  - setBIC
```
public Field255 setBIC(String component1)
```
    Set the BIC (component1).
    
    Parameters:
    component1 - the BIC to set
  - setBIC
```
public Field255 setBIC(BIC component1)
```
    Set the BIC (component1) as BIC
    
    Parameters:
    component1 - BIC with the BIC content 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
  - getSessionNumber
```
public String getSessionNumber()
```
    Get the Session Number (component2).
    
    Returns:
    the Session Number from component2
  - getSessionNumberAsNumber
```
public Number getSessionNumberAsNumber()
```
    Get the Session Number (component2) as Number
    
    Returns:
    the Session Number from component2 converted to Number or null if cannot be converted
  - setComponent2
```
public Field255 setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setComponent2
```
public Field255 setComponent2(Number component2)
```
    Set the component2.
    
    Parameters:
    component2 - the Number with the component2 content to set
  - setSessionNumber
```
public Field255 setSessionNumber(String component2)
```
    Set the Session Number (component2).
    
    Parameters:
    component2 - the Session Number to set
  - setSessionNumber
```
public Field255 setSessionNumber(Number component2)
```
    Set the Session Number (component2) as Number
    
    Parameters:
    component2 - Number with the Session Number content to set
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsNumber
```
public Number getComponent3AsNumber()
```
    Get the component3 as Number
    
    Returns:
    the component3 converted to Number or null if cannot be converted
  - getMessageType
```
public String getMessageType()
```
    Get the Message Type (component3).
    
    Returns:
    the Message Type from component3
  - getMessageTypeAsNumber
```
public Number getMessageTypeAsNumber()
```
    Get the Message Type (component3) as Number
    
    Returns:
    the Message Type from component3 converted to Number or null if cannot be converted
  - setComponent3
```
public Field255 setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setComponent3
```
public Field255 setComponent3(Number component3)
```
    Set the component3.
    
    Parameters:
    component3 - the Number with the component3 content to set
  - setMessageType
```
public Field255 setMessageType(String component3)
```
    Set the Message Type (component3).
    
    Parameters:
    component3 - the Message Type to set
  - setMessageType
```
public Field255 setMessageType(Number component3)
```
    Set the Message Type (component3) as Number
    
    Parameters:
    component3 - Number with the Message Type content to set
  - getComponent4
```
public String getComponent4()
```
    Get the component4
    
    Returns:
    the component4
  - getComponent4AsCalendar
```
public Calendar getComponent4AsCalendar()
```
    Get the component4 as Calendar
    
    Returns:
    the component4 converted to Calendar or null if cannot be converted
  - getDate
```
public String getDate()
```
    Get the Date (component4).
    
    Returns:
    the Date from component4
  - getDateAsCalendar
```
public Calendar getDateAsCalendar()
```
    Get the Date (component4) as Calendar
    
    Returns:
    the Date from component4 converted to Calendar or null if cannot be converted
  - setComponent4
```
public Field255 setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 to set
  - setComponent4
```
public Field255 setComponent4(Calendar component4)
```
    Set the component4.
    
    Parameters:
    component4 - the Calendar with the component4 content to set
  - setDate
```
public Field255 setDate(String component4)
```
    Set the Date (component4).
    
    Parameters:
    component4 - the Date to set
  - setDate
```
public Field255 setDate(Calendar component4)
```
    Set the Date (component4) as Calendar
    
    Parameters:
    component4 - Calendar with the Date content to set
  - getComponent5
```
public String getComponent5()
```
    Get the component5
    
    Returns:
    the component5
  - getComponent5AsCalendar
```
public Calendar getComponent5AsCalendar()
```
    Get the component5 as Calendar
    
    Returns:
    the component5 converted to Calendar or null if cannot be converted
  - getStartTime
```
public String getStartTime()
```
    Get the Start Time (component5).
    
    Returns:
    the Start Time from component5
  - getStartTimeAsCalendar
```
public Calendar getStartTimeAsCalendar()
```
    Get the Start Time (component5) as Calendar
    
    Returns:
    the Start Time from component5 converted to Calendar or null if cannot be converted
  - setComponent5
```
public Field255 setComponent5(String component5)
```
    Set the component5.
    
    Parameters:
    component5 - the component5 to set
  - setComponent5
```
public Field255 setComponent5(Calendar component5)
```
    Set the component5.
    
    Parameters:
    component5 - the Calendar with the component5 content to set
  - setStartTime
```
public Field255 setStartTime(String component5)
```
    Set the Start Time (component5).
    
    Parameters:
    component5 - the Start Time to set
  - setStartTime
```
public Field255 setStartTime(Calendar component5)
```
    Set the Start Time (component5) as Calendar
    
    Parameters:
    component5 - Calendar with the Start Time content to set
  - getComponent6
```
public String getComponent6()
```
    Get the component6
    
    Returns:
    the component6
  - getComponent6AsCalendar
```
public Calendar getComponent6AsCalendar()
```
    Get the component6 as Calendar
    
    Returns:
    the component6 converted to Calendar or null if cannot be converted
  - getEndTime
```
public String getEndTime()
```
    Get the End Time (component6).
    
    Returns:
    the End Time from component6
  - getEndTimeAsCalendar
```
public Calendar getEndTimeAsCalendar()
```
    Get the End Time (component6) as Calendar
    
    Returns:
    the End Time from component6 converted to Calendar or null if cannot be converted
  - setComponent6
```
public Field255 setComponent6(String component6)
```
    Set the component6.
    
    Parameters:
    component6 - the component6 to set
  - setComponent6
```
public Field255 setComponent6(Calendar component6)
```
    Set the component6.
    
    Parameters:
    component6 - the Calendar with the component6 content to set
  - setEndTime
```
public Field255 setEndTime(String component6)
```
    Set the End Time (component6).
    
    Parameters:
    component6 - the End Time to set
  - setEndTime
```
public Field255 setEndTime(Calendar component6)
```
    Set the End Time (component6) as Calendar
    
    Parameters:
    component6 - Calendar with the End Time 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
  - bics
```
public List<BIC> bics()
```
    Description copied from interface: BICContainer
    
    Utility method that creates a BIC for every string returned by BICContainer.bicStrings()
    
    Specified by:
    
    bics in interface BICContainer
  - bicStrings
```
public List<String> bicStrings()
```
    Description copied from interface: BICContainer
    
    Get a list of strings of BICs present in this field
    
    Specified by:
    
    bicStrings in interface BICContainer
    
    Returns:
    a list, with zero or more BICs in this 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
  - 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 Field255
    
    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 Field255 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 Field255 get(SwiftMessage msg)
```
    Get the first instance of Field255 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<Field255> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field255 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<Field255> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field255 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 Field255

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_255

PARSER_PATTERN

COMPONENTS_PATTERN

BIC

SESSION_NUMBER

MESSAGE_TYPE

DATE

START_TIME

END_TIME

Constructor Detail

Field255

Field255

Method Detail

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsBIC

getBIC

getBICAsBIC

setComponent1

setComponent1

setBIC

setBIC

getComponent2

getComponent2AsNumber

getSessionNumber

getSessionNumberAsNumber

setComponent2

setComponent2

setSessionNumber

setSessionNumber

getComponent3

getComponent3AsNumber

getMessageType

getMessageTypeAsNumber

setComponent3

setComponent3

setMessageType

setMessageType

getComponent4

getComponent4AsCalendar

getDate

getDateAsCalendar

setComponent4

setComponent4

setDate

setDate

getComponent5

getComponent5AsCalendar

getStartTime

getStartTimeAsCalendar

setComponent5

setComponent5

setStartTime

setStartTime

getComponent6

getComponent6AsCalendar

getEndTime

getEndTimeAsCalendar

setComponent6

setComponent6

setEndTime

setEndTime

dates

bics

bicStrings

isOptional

isGeneric