Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.prowidesoftware.swift.model.field
Class Field68A

java.lang.Object
  extended by com.prowidesoftware.swift.model.field.Field
      extended by com.prowidesoftware.swift.model.field.Field68A
All Implemented Interfaces:
AmountContainer, CurrencyContainer, PatternContainer, java.io.Serializable
public class Field68A
extends Field
implements java.io.Serializable, CurrencyContainer, AmountContainer

Field 68A

validation pattern: 6n6n/2n[/15][//10x]
parser pattern: NSN/N[/N][//S]
components pattern: NCNNNS

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
Field68A()
          Default constructor
Field68A(java.lang.String value)
          Creates the field parsing the parameter value into fields' components
 
Method Summary
 java.math.BigDecimal amount()
          Get the first amount in this field.
 java.util.List<java.math.BigDecimal> amounts()
           
 java.lang.String componentsPattern()
           
 java.util.List<java.util.Currency> currencies()
          Utility method that creates a Currency for every string returned by CurrencyContainer.currencyStrings()
 java.util.Currency currency()
          Analog to CurrencyContainer.currencyString()
 java.lang.String currencyString()
          Get the single currency contained in this field.
 java.util.List<java.lang.String> currencyStrings()
          Get a list of strings of currencies present in this field
 java.lang.String getComponent1()
          Get the component1
 java.lang.Number getComponent1AsNumber()
          Get the component1 as Number
 java.lang.String getComponent2()
          Get the component2
 java.util.Currency getComponent2AsCurrency()
          Get the component2 as Currency
 java.lang.String getComponent3()
          Get the component3
 java.lang.Number getComponent3AsNumber()
          Get the component3 as Number
 java.lang.String getComponent4()
          Get the component4
 java.lang.Number getComponent4AsNumber()
          Get the component4 as Number
 java.lang.String getComponent5()
          Get the component5
 java.lang.Number getComponent5AsNumber()
          Get the component5 as Number
 java.lang.String getComponent6()
          Get the component6
 java.lang.String getComponent6AsString()
          Deprecated. 
 java.lang.String getValue()
          Serializes the fields' components into the single string value (SWIFT format)
 void initializeCurrencies(java.util.Currency cur)
           
 void initializeCurrencies(java.lang.String cur)
          set the currency of this field.
 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 setComponent1(java.lang.Number component1)
          Set the component1.
 void setComponent1(java.lang.String component1)
          Set the component1.
 void setComponent2(java.util.Currency component2)
          Set the component2.
 void setComponent2(java.lang.String component2)
          Set the component2.
 void setComponent3(java.lang.Number component3)
          Set the component3.
 void setComponent3(java.lang.String component3)
          Set the component3.
 void setComponent4(java.lang.Number component4)
          Set the component4.
 void setComponent4(java.lang.String component4)
          Set the component4.
 void setComponent5(java.lang.Number component5)
          Set the component5.
 void setComponent5(java.lang.String component5)
          Set the component5.
 void setComponent6(java.lang.String component6)
          Set the component6.
 
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

Field68A

public Field68A()
Default constructor

Field68A

public Field68A(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

getComponent1AsNumber

public java.lang.Number getComponent1AsNumber()
Get the component1 as Number

Returns:
the component1 converted to Number or null if cannot be converted

setComponent1

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

Parameters:
component1 - the component1 to set

setComponent1

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

Parameters:
component1 - the Number with the component1 content to set

getComponent2

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

Returns:
the component2

getComponent2AsCurrency

public java.util.Currency getComponent2AsCurrency()
Get the component2 as Currency

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

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

getComponent3

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

Returns:
the component3

getComponent3AsNumber

public java.lang.Number getComponent3AsNumber()
Get the component3 as Number

Returns:
the component3 converted to Number or null if cannot be converted

setComponent3

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

Parameters:
component3 - the component3 to set

setComponent3

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

Parameters:
component3 - the Number with the component3 content to set

getComponent4

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

Returns:
the component4

getComponent4AsNumber

public java.lang.Number getComponent4AsNumber()
Get the component4 as Number

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

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

getComponent5

public java.lang.String getComponent5()
Get the component5

Returns:
the component5

getComponent5AsNumber

public java.lang.Number getComponent5AsNumber()
Get the component5 as Number

Returns:
the component5 converted to Number or null if cannot be converted

setComponent5

public void setComponent5(java.lang.String component5)
Set the component5.

Parameters:
component5 - the component5 to set

setComponent5

public void setComponent5(java.lang.Number component5)
Set the component5.

Parameters:
component5 - the Number with the component5 content to set

getComponent6

public java.lang.String getComponent6()
Get the component6

Returns:
the component6

getComponent6AsString

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

Same as getComponent(6)

setComponent6

public void setComponent6(java.lang.String component6)
Set the component6.

Parameters:
component6 - the component6 to set

currencyStrings

public java.util.List<java.lang.String> currencyStrings()
Description copied from interface: CurrencyContainer
Get a list of strings of currencies present in this field

Specified by:
currencyStrings in interface CurrencyContainer
Returns:
a list, with zero or more currencies in this field.

currencies

public java.util.List<java.util.Currency> currencies()
Description copied from interface: CurrencyContainer
Utility method that creates a Currency for every string returned by CurrencyContainer.currencyStrings()

Specified by:
currencies in interface CurrencyContainer

currency

public java.util.Currency currency()
Description copied from interface: CurrencyContainer
Analog to CurrencyContainer.currencyString()

Specified by:
currency in interface CurrencyContainer
See Also:
CurrencyContainer.currencyStrings(), CurrencyContainer.currencyString()

currencyString

public java.lang.String currencyString()
Description copied from interface: CurrencyContainer
Get the single currency contained in this field.

Specified by:
currencyString in interface CurrencyContainer
Returns:
null if no currency is contained - which should never happen, or throws an exception if more than one currency is present in this field.

initializeCurrencies

public void initializeCurrencies(java.lang.String cur)
Description copied from interface: CurrencyContainer
set the currency of this field. If this field contains more than one currency then all currency components will be set. Individual setComponentNN should be used to set only one component of the field.

Specified by:
initializeCurrencies in interface CurrencyContainer

initializeCurrencies

public void initializeCurrencies(java.util.Currency cur)
Specified by:
initializeCurrencies in interface CurrencyContainer
See Also:
CurrencyContainer.initializeCurrencies(String)

amounts

public java.util.List<java.math.BigDecimal> amounts()

amount

public java.math.BigDecimal amount()
Description copied from interface: AmountContainer
Get the first amount in this field.

Specified by:
amount in interface AmountContainer

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
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD