com.prowidesoftware.swift.model.field
Class Field23

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

public class Field23
extends Field
implements java.io.Serializable

Field 23

validation pattern: CUSTOM
parser pattern: S[/S/S[/S]]
components pattern: SSSC

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
Field23()
          Default constructor
Field23(java.lang.String value)
          Creates the field parsing the parameter value into fields' components
 
Method Summary
 java.lang.String componentsPattern()
           
 java.lang.String getCode1()
          Get the Code 1 (component1).
 java.lang.String getCode2()
          Get the Code 2 (component2).
 java.lang.String getCode3()
          Get the Code 3 (component3).
 java.lang.String getComponent1()
          Get the component1
 java.lang.String getComponent1AsString()
          Deprecated. 
 java.lang.String getComponent2()
          Get the component2
 java.lang.String getComponent2AsString()
          Deprecated. 
 java.lang.String getComponent3()
          Get the component3
 java.lang.String getComponent3AsString()
          Deprecated. 
 java.lang.String getComponent4()
          Get the component4
 java.util.Currency getComponent4AsCurrency()
          Get the component4 as Currency
 java.lang.String getCurrency()
          Get the Currency (component4).
 java.util.Currency getCurrencyAsCurrency()
          Get the Currency (component4) as Currency
 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 setCode1(java.lang.String component1)
          Set the Code 1 (component1).
 void setCode2(java.lang.String component2)
          Set the Code 2 (component2).
 void setCode3(java.lang.String component3)
          Set the Code 3 (component3).
 void setComponent1(java.lang.String component1)
          Set the component1.
 void setComponent2(java.lang.String component2)
          Set the component2.
 void setComponent3(java.lang.String component3)
          Set the component3.
 void setComponent4(java.util.Currency component4)
          Set the component4.
 void setComponent4(java.lang.String component4)
          Set the component4.
 void setCurrency(java.util.Currency component4)
          Set the Currency (component4) as Currency
 void setCurrency(java.lang.String component4)
          Set the Currency (component4).
 
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

Field23

public Field23()
Default constructor


Field23

public Field23(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)


getCode1

public java.lang.String getCode1()
Get the Code 1 (component1).

Returns:
the Code 1 from component1

setComponent1

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

Parameters:
component1 - the component1 to set

setCode1

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

Parameters:
component1 - the Code 1 to set

getComponent2

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

Returns:
the component2

getComponent2AsString

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

Same as getComponent(2)


getCode2

public java.lang.String getCode2()
Get the Code 2 (component2).

Returns:
the Code 2 from component2

setComponent2

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

Parameters:
component2 - the component2 to set

setCode2

public void setCode2(java.lang.String component2)
Set the Code 2 (component2).

Parameters:
component2 - the Code 2 to set

getComponent3

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

Returns:
the component3

getComponent3AsString

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

Same as getComponent(3)


getCode3

public java.lang.String getCode3()
Get the Code 3 (component3).

Returns:
the Code 3 from component3

setComponent3

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

Parameters:
component3 - the component3 to set

setCode3

public void setCode3(java.lang.String component3)
Set the Code 3 (component3).

Parameters:
component3 - the Code 3 to set

getComponent4

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

Returns:
the component4

getComponent4AsCurrency

public java.util.Currency getComponent4AsCurrency()
Get the component4 as Currency

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

getCurrency

public java.lang.String getCurrency()
Get the Currency (component4).

Returns:
the Currency from component4

getCurrencyAsCurrency

public java.util.Currency getCurrencyAsCurrency()
Get the Currency (component4) as Currency

Returns:
the Currency from component4 converted to Currency 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.Currency component4)
Set the component4.

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

setCurrency

public void setCurrency(java.lang.String component4)
Set the Currency (component4).

Parameters:
component4 - the Currency to set

setCurrency

public void setCurrency(java.util.Currency component4)
Set the Currency (component4) as Currency

Parameters:
component4 - Currency with the Currency 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