Field255 (Prowide Integrator API Reference)

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

All Implemented Interfaces:

DateContainer, PatternContainer, Serializable
```
@Generated
public class Field255
extends Field
implements Serializable, DateContainer
```
SWIFT MT Field 255
Model and parser for field 255 of a SWIFT MT message.
Subfields (components) Data types
1. LogicalTerminalAddress
2. Number
3. Number
4. Calendar
5. Calendar
6. Calendar
Structure definition
- validation pattern: <LT>4!n<MT><DATE2>[<HHMM><HHMM>]
- parser pattern: <LT>4!N<MT><DATE2>[<HHMM><HHMM>]
- components pattern: ZNMEHH
This class complies with standard release SRU2017

NOTE: this source code has been generated from template
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 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`	`LT_ADDRESS` Component number for the LT Address subfield
`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 int`	`SRU` Constant identifying the SRU to which this class belongs to.
`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 a new field and initializes its components with content from the parameter value.
`Field255(Tag tag)` Creates a new field and initializes its components with content from the parameter tag.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`componentsPattern()` Returns the field's 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.
`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`	`getComponent1()` Get the component1
`LogicalTerminalAddress`	`getComponent1AsLogicalTerminalAddress()` Get the component1 as LogicalTerminalAddress
`String`	`getComponent2()` Get the component2
`Number`	`getComponent2AsNumber()` Get the component2 as Number
`String`	`getComponent3()` Get the component3
`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
`protected List<String>`	`getComponentLabels()` Returns english label for components.
`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`	`getLTAddress()` Get the LT Address (component1).
`LogicalTerminalAddress`	`getLTAddressAsLogicalTerminalAddress()` Get the LT Address (component1) as LogicalTerminalAddress
`String`	`getMessageType()` Get the Message Type (component3).
`String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`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)
`String`	`getValueDisplay(int component, 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 Field255`	`newInstance(Field255 source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`void`	`parse(String value)` Parses the parameter value into the internal components structure.
`String`	`parserPattern()`
`Field255`	`setComponent1(LogicalTerminalAddress component1)` Set the component1 from a LogicalTerminalAddress object.
`Field255`	`setComponent1(String component1)` Set the component1.
`Field255`	`setComponent2(Number component2)` Set the component2 from a Number object.
`Field255`	`setComponent2(String component2)` Set the component2.
`Field255`	`setComponent3(String component3)` Set the component3.
`Field255`	`setComponent4(Calendar component4)` Set the component4 from a Calendar object.
`Field255`	`setComponent4(String component4)` Set the component4.
`Field255`	`setComponent5(Calendar component5)` Set the component5 from a Calendar object.
`Field255`	`setComponent5(String component5)` Set the component5.
`Field255`	`setComponent6(Calendar component6)` Set the component6 from a Calendar object.
`Field255`	`setComponent6(String component6)` Set the component6.
`Field255`	`setDate(Calendar component4)` Set the Date (component4) from a Calendar object.
`Field255`	`setDate(String component4)` Set the Date (component4).
`Field255`	`setEndTime(Calendar component6)` Set the End Time (component6) from a Calendar object.
`Field255`	`setEndTime(String component6)` Set the End Time (component6).
`Field255`	`setLTAddress(LogicalTerminalAddress component1)` Set the LT Address (component1) from a LogicalTerminalAddress object.
`Field255`	`setLTAddress(String component1)` Set the LT Address (component1).
`Field255`	`setMessageType(String component3)` Set the Message Type (component3).
`Field255`	`setSessionNumber(Number component2)` Set the Session Number (component2) from a Number object.
`Field255`	`setSessionNumber(String component2)` Set the Session Number (component2).
`Field255`	`setStartTime(Calendar component5)` Set the Start Time (component5) from a Calendar object.
`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.
`String`	`validatorPattern()` Returns the field's validators pattern

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

Methods inherited from class java.lang.Object
clone, finalize, 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 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
  - LT_ADDRESS
```
public static final Integer LT_ADDRESS
```
    Component number for the LT Address 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. Creates a new field setting all components to null.
  - Field255
```
public Field255(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
  - Field255
```
public Field255(Tag tag)
```
    Creates a new field and initializes its components with content from the parameter tag. The value is parsed with parse(String)
    
    Throws:
    
    IllegalArgumentException - if the parameter tag is null or its tagname does not match the field name
    Since:
    
    7.8
- Method Detail
  - parse
```
public void parse(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
  - 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)
    
    Specified by:
    
    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
  - getComponent1AsLogicalTerminalAddress
```
public LogicalTerminalAddress getComponent1AsLogicalTerminalAddress()
```
    Get the component1 as LogicalTerminalAddress
    
    Returns:
    the component1 converted to LogicalTerminalAddress or null if cannot be converted
  - getLTAddress
```
public String getLTAddress()
```
    Get the LT Address (component1).
    
    Returns:
    the LT Address from component1
  - getLTAddressAsLogicalTerminalAddress
```
public LogicalTerminalAddress getLTAddressAsLogicalTerminalAddress()
```
    Get the LT Address (component1) as LogicalTerminalAddress
    
    Returns:
    the LT Address from component1 converted to LogicalTerminalAddress 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(LogicalTerminalAddress component1)
```
    Set the component1 from a LogicalTerminalAddress object.
    
    Parameters:
    component1 - the LogicalTerminalAddress with the component1 content to set
  - setLTAddress
```
public Field255 setLTAddress(String component1)
```
    Set the LT Address (component1).
    
    Parameters:
    component1 - the LT Address to set
  - setLTAddress
```
public Field255 setLTAddress(LogicalTerminalAddress component1)
```
    Set the LT Address (component1) from a LogicalTerminalAddress object.
    
    Parameters:
    component1 - LogicalTerminalAddress with the LT Address content to set
    See Also:
    setComponent1(com.prowidesoftware.swift.model.LogicalTerminalAddress)
  - 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 from a Number object.
    If the component being set is a fixed length number, the argument will not be padded. It is recommended for these cases to use the setComponent2(String) method.
    
    Parameters:
    component2 - the Number with the component2 content to set
    See Also:
    setComponent2(String)
  - 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) from a Number object.
    
    Parameters:
    component2 - Number with the Session Number content to set
    See Also:
    setComponent2(java.lang.Number)
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getMessageType
```
public String getMessageType()
```
    Get the Message Type (component3).
    
    Returns:
    the Message Type from component3
  - setComponent3
```
public Field255 setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setMessageType
```
public Field255 setMessageType(String component3)
```
    Set the Message Type (component3).
    
    Parameters:
    component3 - the Message Type 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 from a Calendar object.
    
    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) from a Calendar object.
    
    Parameters:
    component4 - Calendar with the Date content to set
    See Also:
    setComponent4(java.util.Calendar)
  - 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 from a Calendar object.
    
    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) from a Calendar object.
    
    Parameters:
    component5 - Calendar with the Start Time content to set
    See Also:
    setComponent5(java.util.Calendar)
  - 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 from a Calendar object.
    
    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) from a Calendar object.
    
    Parameters:
    component6 - Calendar with the End Time content to set
    See Also:
    setComponent6(java.util.Calendar)
  - 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
  - parserPattern
```
public String parserPattern()
```
    Specified by:
    
    parserPattern in interface PatternContainer
  - getName
```
public 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 Field255.NAME
  - componentsPattern
```
public final String componentsPattern()
```
    Returns the field's components pattern
    
    Specified by:
    
    componentsPattern in interface PatternContainer
    
    Specified by:
    
    componentsPattern in class Field
    
    Returns:
    the static value of Field255.COMPONENTS_PATTERN
  - validatorPattern
```
public final String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern 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
  - getValueDisplay
```
public String getValueDisplay(int component,
                     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:
    
    IllegalArgumentException - if component number is invalid for the field
    Since:
    
    7.8
  - getComponentLabels
```
protected List<String> getComponentLabels()
```
    Returns english label for components.
    The index in the list is in sync with specific field component structure.
    
    Specified by:
    
    getComponentLabels in class Field
    
    Since:
    
    7.8.4
    
    See Also:
    Field.getComponentLabel(int)

Class Field255

SWIFT MT Field 255

Subfields (components) Data types

Structure definition

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

SRU

NAME

F_255

PARSER_PATTERN

COMPONENTS_PATTERN

LT_ADDRESS

SESSION_NUMBER

MESSAGE_TYPE

DATE

START_TIME

END_TIME

Constructor Detail

Field255

Field255

Field255

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsLogicalTerminalAddress

getLTAddress

getLTAddressAsLogicalTerminalAddress

setComponent1

setComponent1

setLTAddress

setLTAddress

getComponent2

getComponent2AsNumber

getSessionNumber

getSessionNumberAsNumber

setComponent2

setComponent2

setSessionNumber

setSessionNumber

getComponent3

getMessageType

setComponent3

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

isOptional

isGeneric

parserPattern