com.prowidesoftware.swift.model.field
Class Field13C

java.lang.Object
  extended by com.prowidesoftware.swift.model.field.Field
      extended by com.prowidesoftware.swift.model.field.Field13C
All Implemented Interfaces:
PatternContainer, java.io.Serializable

public class Field13C
extends Field
implements java.io.Serializable

Field 13C

validation pattern: /8c/
parser pattern: /S/
components pattern: SHGO

Components Data types

NOTE: this source code has been generated.

Author:
www.prowidesoftware.com
See Also:
Serialized Form

Field Summary
static java.lang.String COMPONENTS_PATTERN
           
static java.lang.String NAME
           
static java.lang.String PARSER_PATTERN
           
 
Fields inherited from class com.prowidesoftware.swift.model.field.Field
components
 
Constructor Summary
Field13C()
          Default constructor
Field13C(java.lang.String value)
          Creates the field parsing the parameter value into fields' components
 
Method Summary
 java.lang.String componentsPattern()
           
 java.lang.String getCode()
          Get the Code (component1).
 java.lang.String getComponent1()
          Get the component1
 java.lang.String getComponent1AsString()
          Deprecated. 
 java.lang.String getComponent2()
          Get the component2
 java.util.Calendar getComponent2AsCalendar()
          Get the component2 as Calendar
 java.lang.String getComponent3()
          Get the component3
 java.lang.String getComponent4()
          Get the component4
 java.util.Calendar getComponent4AsCalendar()
          Get the component4 as Calendar
 java.lang.String getOffset()
          Get the Offset (component4).
 java.util.Calendar getOffsetAsCalendar()
          Get the Offset (component4) as Calendar
 java.lang.String getSign()
          Get the Sign (component3).
 java.lang.String getTime()
          Get the Time (component2).
 java.util.Calendar getTimeAsCalendar()
          Get the Time (component2) as Calendar
 java.lang.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.
 java.lang.String parserPattern()
           
 void setCode(java.lang.String component1)
          Set the Code (component1).
 void setComponent1(java.lang.String component1)
          Set the component1.
 void setComponent2(java.util.Calendar component2)
          Set the component2.
 void setComponent2(java.lang.String component2)
          Set the component2.
 void setComponent3(java.lang.String component3)
          Set the component3.
 void setComponent4(java.util.Calendar component4)
          Set the component4.
 void setComponent4(java.lang.String component4)
          Set the component4.
 void setOffset(java.util.Calendar component4)
          Set the Offset (component4) as Calendar
 void setOffset(java.lang.String component4)
          Set the Offset (component4).
 void setSign(java.lang.String component3)
          Set the Sign (component3).
 void setTime(java.util.Calendar component2)
          Set the Time (component2) as Calendar
 void setTime(java.lang.String component2)
          Set the Time (component2).
 
Methods inherited from class com.prowidesoftware.swift.model.field.Field
appendInLines, appendInLines, equals, findComponentStartingWith, format, formatAccount, formatNumber, getAsBigDecimal, getComponent, getComponentAs, getComponents, getConditionalQualifier, getDSS, getField, getLabel, getLabel, getLabel, getLabel, getName, getValueByCodeword, getValueDisplay, hashCode, isDSSPresent, isEmpty, joinComponents, joinComponents, joinComponents, joinComponents, setComponent, setComponents, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values

PARSER_PATTERN

public static final java.lang.String PARSER_PATTERN
See Also:
Constant Field Values

COMPONENTS_PATTERN

public static final java.lang.String COMPONENTS_PATTERN
See Also:
Constant Field Values
Constructor Detail

Field13C

public Field13C()
Default constructor


Field13C

public Field13C(java.lang.String value)
Creates the field parsing the parameter value into fields' components

Parameters:
value -
Method Detail

getValue

public java.lang.String getValue()
Serializes the fields' components into the single string value (SWIFT format)

Overrides:
getValue in class Field
Returns:
SWIFT formatted value

getComponent1

public java.lang.String getComponent1()
Get the component1

Returns:
the component1

getComponent1AsString

@Deprecated
public java.lang.String getComponent1AsString()
Deprecated. 

Same as getComponent(1)


getCode

public java.lang.String getCode()
Get the Code (component1).

Returns:
the Code from component1

setComponent1

public void setComponent1(java.lang.String component1)
Set the component1.

Parameters:
component1 - the component1 to set

setCode

public void setCode(java.lang.String component1)
Set the Code (component1).

Parameters:
component1 - the Code to set

getComponent2

public java.lang.String getComponent2()
Get the component2

Returns:
the component2

getComponent2AsCalendar

public java.util.Calendar getComponent2AsCalendar()
Get the component2 as Calendar

Returns:
the component2 converted to Calendar or null if cannot be converted

getTime

public java.lang.String getTime()
Get the Time (component2).

Returns:
the Time from component2

getTimeAsCalendar

public java.util.Calendar getTimeAsCalendar()
Get the Time (component2) as Calendar

Returns:
the Time from component2 converted to Calendar or null if cannot be converted

setComponent2

public void setComponent2(java.lang.String component2)
Set the component2.

Parameters:
component2 - the component2 to set

setComponent2

public void setComponent2(java.util.Calendar component2)
Set the component2.

Parameters:
component2 - the Calendar with the component2 content to set

setTime

public void setTime(java.lang.String component2)
Set the Time (component2).

Parameters:
component2 - the Time to set

setTime

public void setTime(java.util.Calendar component2)
Set the Time (component2) as Calendar

Parameters:
component2 - Calendar with the Time content to set

getComponent3

public java.lang.String getComponent3()
Get the component3

Returns:
the component3

getSign

public java.lang.String getSign()
Get the Sign (component3).

Returns:
the Sign from component3

setComponent3

public void setComponent3(java.lang.String component3)
Set the component3.

Parameters:
component3 - the component3 to set

setSign

public void setSign(java.lang.String component3)
Set the Sign (component3).

Parameters:
component3 - the Sign to set

getComponent4

public java.lang.String getComponent4()
Get the component4

Returns:
the component4

getComponent4AsCalendar

public java.util.Calendar getComponent4AsCalendar()
Get the component4 as Calendar

Returns:
the component4 converted to Calendar or null if cannot be converted

getOffset

public java.lang.String getOffset()
Get the Offset (component4).

Returns:
the Offset from component4

getOffsetAsCalendar

public java.util.Calendar getOffsetAsCalendar()
Get the Offset (component4) as Calendar

Returns:
the Offset from component4 converted to Calendar or null if cannot be converted

setComponent4

public void setComponent4(java.lang.String component4)
Set the component4.

Parameters:
component4 - the component4 to set

setComponent4

public void setComponent4(java.util.Calendar component4)
Set the component4.

Parameters:
component4 - the Calendar with the component4 content to set

setOffset

public void setOffset(java.lang.String component4)
Set the Offset (component4).

Parameters:
component4 - the Offset to set

setOffset

public void setOffset(java.util.Calendar component4)
Set the Offset (component4) as Calendar

Parameters:
component4 - Calendar with the Offset content to set

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 java.lang.String componentsPattern()
Specified by:
componentsPattern in interface PatternContainer

parserPattern

public java.lang.String parserPattern()
Specified by:
parserPattern in interface PatternContainer