Field252 (Prowide Integrator API Reference)

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

All Implemented Interfaces:

PatternContainer, Serializable
```
@Generated
public class Field252
extends Field
implements Serializable
```
Field 252

validation pattern: <MIR><MIR>[<HHMM><HHMM>]
parser pattern: <MIR><MIR>[<HHMM><HHMM>]
components pattern: RRHH

Components Data types
- component1: MIR
- component2: MIR
- component3: Calendar
- component4: Calendar
NOTE: this source code has been generated from template This class complies with standard release SRU2016
See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMPONENTS_PATTERN`
`static Integer`	`END_MIR` Component number for the End MIR subfield
`static Integer`	`END_TIME` Component number for the End Time subfield
`static String`	`F_252` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 252
`static String`	`PARSER_PATTERN`
`static int`	`SRU` Constant identifying the SRU to which this class belongs to.
`static Integer`	`START_MIR` Component number for the Start MIR 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
`Field252()` Default constructor.
`Field252(String value)` Creates a new field and initializes its components with content from the parameter value.
`Field252(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.
`static Tag`	`emptyTag()` Create a Tag with this field name and an empty string as value Shorthand for `new Tag(NAME, "")`
`static Field252`	`get(SwiftMessage msg)` Get the first instance of Field252 in the given message.
`static Field252`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field252>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field252 in the given message an empty list is returned if none found.
`static List<Field252>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field252 from the given block an empty list is returned if none found.
`String`	`getComponent1()` Get the component1
`MIR`	`getComponent1AsMIR()` Get the component1 as MIR
`String`	`getComponent2()` Get the component2
`MIR`	`getComponent2AsMIR()` Get the component2 as MIR
`String`	`getComponent3()` Get the component3
`Calendar`	`getComponent3AsCalendar()` Get the component3 as Calendar
`String`	`getComponent4()` Get the component4
`Calendar`	`getComponent4AsCalendar()` Get the component4 as Calendar
`protected List<String>`	`getComponentLabels()` Returns english label for components.
`String`	`getEndMIR()` Get the End MIR (component2).
`MIR`	`getEndMIRAsMIR()` Get the End MIR (component2) as MIR
`String`	`getEndTime()` Get the End Time (component4).
`Calendar`	`getEndTimeAsCalendar()` Get the End Time (component4) as Calendar
`String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`String`	`getStartMIR()` Get the Start MIR (component1).
`MIR`	`getStartMIRAsMIR()` Get the Start MIR (component1) as MIR
`String`	`getStartTime()` Get the Start Time (component3).
`Calendar`	`getStartTimeAsCalendar()` Get the Start Time (component3) 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 Field252`	`newInstance(Field252 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()`
`Field252`	`setComponent1(MIR component1)` Set the component1 from a MIR object.
`Field252`	`setComponent1(String component1)` Set the component1.
`Field252`	`setComponent2(MIR component2)` Set the component2 from a MIR object.
`Field252`	`setComponent2(String component2)` Set the component2.
`Field252`	`setComponent3(Calendar component3)` Set the component3 from a Calendar object.
`Field252`	`setComponent3(String component3)` Set the component3.
`Field252`	`setComponent4(Calendar component4)` Set the component4 from a Calendar object.
`Field252`	`setComponent4(String component4)` Set the component4.
`Field252`	`setEndMIR(MIR component2)` Set the End MIR (component2) from a MIR object.
`Field252`	`setEndMIR(String component2)` Set the End MIR (component2).
`Field252`	`setEndTime(Calendar component4)` Set the End Time (component4) from a Calendar object.
`Field252`	`setEndTime(String component4)` Set the End Time (component4).
`Field252`	`setStartMIR(MIR component1)` Set the Start MIR (component1) from a MIR object.
`Field252`	`setStartMIR(String component1)` Set the Start MIR (component1).
`Field252`	`setStartTime(Calendar component3)` Set the Start Time (component3) from a Calendar object.
`Field252`	`setStartTime(String component3)` Set the Start Time (component3).
`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
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, 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 252
    
    See Also:
    Constant Field Values
  - F_252
```
public static final String F_252
```
    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
  - START_MIR
```
public static final Integer START_MIR
```
    Component number for the Start MIR subfield
  - END_MIR
```
public static final Integer END_MIR
```
    Component number for the End MIR 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
  - Field252
```
public Field252()
```
    Default constructor. Creates a new field setting all components to null.
  - Field252
```
public Field252(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
  - Field252
```
public Field252(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 components value is overwritten.
    
    Overrides:
    
    parse in class Field
    
    Parameters:
    value - complete field value including separators and CRLF
    Since:
    
    7.8
  - newInstance
```
public static Field252 newInstance(Field252 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
  - getComponent1AsMIR
```
public MIR getComponent1AsMIR()
```
    Get the component1 as MIR
    
    Returns:
    the component1 converted to MIR or null if cannot be converted
  - getStartMIR
```
public String getStartMIR()
```
    Get the Start MIR (component1).
    
    Returns:
    the Start MIR from component1
  - getStartMIRAsMIR
```
public MIR getStartMIRAsMIR()
```
    Get the Start MIR (component1) as MIR
    
    Returns:
    the Start MIR from component1 converted to MIR or null if cannot be converted
  - setComponent1
```
public Field252 setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setComponent1
```
public Field252 setComponent1(MIR component1)
```
    Set the component1 from a MIR object.
    
    Parameters:
    component1 - the MIR with the component1 content to set
  - setStartMIR
```
public Field252 setStartMIR(String component1)
```
    Set the Start MIR (component1).
    
    Parameters:
    component1 - the Start MIR to set
  - setStartMIR
```
public Field252 setStartMIR(MIR component1)
```
    Set the Start MIR (component1) from a MIR object.
    
    Parameters:
    component1 - MIR with the Start MIR content to set
    See Also:
    setComponent1(com.prowidesoftware.swift.model.MIR)
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsMIR
```
public MIR getComponent2AsMIR()
```
    Get the component2 as MIR
    
    Returns:
    the component2 converted to MIR or null if cannot be converted
  - getEndMIR
```
public String getEndMIR()
```
    Get the End MIR (component2).
    
    Returns:
    the End MIR from component2
  - getEndMIRAsMIR
```
public MIR getEndMIRAsMIR()
```
    Get the End MIR (component2) as MIR
    
    Returns:
    the End MIR from component2 converted to MIR or null if cannot be converted
  - setComponent2
```
public Field252 setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setComponent2
```
public Field252 setComponent2(MIR component2)
```
    Set the component2 from a MIR object.
    
    Parameters:
    component2 - the MIR with the component2 content to set
  - setEndMIR
```
public Field252 setEndMIR(String component2)
```
    Set the End MIR (component2).
    
    Parameters:
    component2 - the End MIR to set
  - setEndMIR
```
public Field252 setEndMIR(MIR component2)
```
    Set the End MIR (component2) from a MIR object.
    
    Parameters:
    component2 - MIR with the End MIR content to set
    See Also:
    setComponent2(com.prowidesoftware.swift.model.MIR)
  - 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
  - getStartTime
```
public String getStartTime()
```
    Get the Start Time (component3).
    
    Returns:
    the Start Time from component3
  - getStartTimeAsCalendar
```
public Calendar getStartTimeAsCalendar()
```
    Get the Start Time (component3) as Calendar
    
    Returns:
    the Start Time from component3 converted to Calendar or null if cannot be converted
  - setComponent3
```
public Field252 setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setComponent3
```
public Field252 setComponent3(Calendar component3)
```
    Set the component3 from a Calendar object.
    
    Parameters:
    component3 - the Calendar with the component3 content to set
  - setStartTime
```
public Field252 setStartTime(String component3)
```
    Set the Start Time (component3).
    
    Parameters:
    component3 - the Start Time to set
  - setStartTime
```
public Field252 setStartTime(Calendar component3)
```
    Set the Start Time (component3) from a Calendar object.
    
    Parameters:
    component3 - Calendar with the Start Time content to set
    See Also:
    setComponent3(java.util.Calendar)
  - 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
  - getEndTime
```
public String getEndTime()
```
    Get the End Time (component4).
    
    Returns:
    the End Time from component4
  - getEndTimeAsCalendar
```
public Calendar getEndTimeAsCalendar()
```
    Get the End Time (component4) as Calendar
    
    Returns:
    the End Time from component4 converted to Calendar or null if cannot be converted
  - setComponent4
```
public Field252 setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 to set
  - setComponent4
```
public Field252 setComponent4(Calendar component4)
```
    Set the component4 from a Calendar object.
    
    Parameters:
    component4 - the Calendar with the component4 content to set
  - setEndTime
```
public Field252 setEndTime(String component4)
```
    Set the End Time (component4).
    
    Parameters:
    component4 - the End Time to set
  - setEndTime
```
public Field252 setEndTime(Calendar component4)
```
    Set the End Time (component4) from a Calendar object.
    
    Parameters:
    component4 - Calendar with the End Time content to set
    See Also:
    setComponent4(java.util.Calendar)
  - 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 Field252.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 Field252.COMPONENTS_PATTERN
  - validatorPattern
```
public final String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field252 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 Field252 get(SwiftMessage msg)
```
    Get the first instance of Field252 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<Field252> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field252 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<Field252> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field252 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 Field252

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

SRU

NAME

F_252

PARSER_PATTERN

COMPONENTS_PATTERN

START_MIR

END_MIR

START_TIME

END_TIME

Constructor Detail

Field252

Field252

Field252

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsMIR

getStartMIR

getStartMIRAsMIR

setComponent1

setComponent1

setStartMIR

setStartMIR

getComponent2

getComponent2AsMIR

getEndMIR

getEndMIRAsMIR

setComponent2

setComponent2

setEndMIR

setEndMIR

getComponent3

getComponent3AsCalendar

getStartTime

getStartTimeAsCalendar

setComponent3

setComponent3

setStartTime

setStartTime

getComponent4

getComponent4AsCalendar

getEndTime

getEndTimeAsCalendar

setComponent4

setComponent4

setEndTime

setEndTime

isOptional

isGeneric

parserPattern

getName

componentsPattern

validatorPattern

get

get

getAll

getAll

componentsSize

getValueDisplay

getComponentLabels