Field34N (Prowide Integrator API Reference)

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

All Implemented Interfaces:

AmountContainer, CurrencyContainer, DateContainer, PatternContainer, Serializable
```
@Generated
public class Field34N
extends Field
implements Serializable, CurrencyContainer, DateContainer, AmountContainer
```
Field 34N

validation pattern: [<N>]<DATE2><CUR><AMOUNT>15
parser pattern: [c]<DATE2>SN
components pattern: SECN

Components Data types
- component1: String
- component2: Calendar
- component3: Currency
- component4: Number
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 Integer`	`AMOUNT` Component number for the Amount subfield
`static String`	`COMPONENTS_PATTERN`
`static Integer`	`CURRENCY` Component number for the Currency subfield
`static Integer`	`DATE` Component number for the Date subfield
`static String`	`F_34N` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 34N
`static String`	`PARSER_PATTERN`
`static Integer`	`SIGN` Component number for the Sign subfield
`static int`	`SRU` Constant identifying the SRU to which this class belongs to.

Fields inherited from class com.prowidesoftware.swift.model.field.Field
components

Constructor Summary

Constructors
Constructor and Description
`Field34N()` Default constructor.
`Field34N(String value)` Creates a new field and initializes its components with content from the parameter value.
`Field34N(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
`BigDecimal`	`amount()` Get the first amount in this field.
`List<BigDecimal>`	`amounts()`
`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<Currency>`	`currencies()` Utility method that creates a Currency for every string returned by `CurrencyContainer.currencyStrings()`
`Currency`	`currency()` Analog to `CurrencyContainer.currencyString()`
`String`	`currencyString()` Get the single currency contained in this field.
`List<String>`	`currencyStrings()` Get a list of strings of currencies present in this field
`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 Field34N`	`get(SwiftMessage msg)` Get the first instance of Field34N in the given message.
`static Field34N`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field34N>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field34N in the given message an empty list is returned if none found.
`static List<Field34N>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field34N from the given block an empty list is returned if none found.
`String`	`getAmount()` Get the Amount (component4).
`Number`	`getAmountAsNumber()` Get the Amount (component4) as Number
`String`	`getComponent1()` Get the component1
`String`	`getComponent1AsString()` Deprecated.
`String`	`getComponent2()` Get the component2
`Calendar`	`getComponent2AsCalendar()` Get the component2 as Calendar
`String`	`getComponent3()` Get the component3
`Currency`	`getComponent3AsCurrency()` Get the component3 as Currency
`String`	`getComponent4()` Get the component4
`Number`	`getComponent4AsNumber()` Get the component4 as Number
`protected List<String>`	`getComponentLabels()` Returns english label for components.
`String`	`getCurrency()` Get the Currency (component3).
`Currency`	`getCurrencyAsCurrency()` Get the Currency (component3) as Currency
`String`	`getDate()` Get the Date (component2).
`Calendar`	`getDateAsCalendar()` Get the Date (component2) as Calendar
`String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`String`	`getSign()` Get the Sign (component1).
`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.
`void`	`initializeCurrencies(Currency cur)`
`void`	`initializeCurrencies(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.
`static Field34N`	`newInstance(Field34N 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()`
`Field34N`	`setAmount(Number component4)` Set the Amount (component4) from a Number object.
`Field34N`	`setAmount(String component4)` Set the Amount (component4).
`Field34N`	`setComponent1(String component1)` Set the component1.
`Field34N`	`setComponent2(Calendar component2)` Set the component2 from a Calendar object.
`Field34N`	`setComponent2(String component2)` Set the component2.
`Field34N`	`setComponent3(Currency component3)` Set the component3 from a Currency object.
`Field34N`	`setComponent3(String component3)` Set the component3.
`Field34N`	`setComponent4(Number component4)` Set the component4 from a Number object.
`Field34N`	`setComponent4(String component4)` Set the component4.
`Field34N`	`setCurrency(Currency component3)` Set the Currency (component3) from a Currency object.
`Field34N`	`setCurrency(String component3)` Set the Currency (component3).
`Field34N`	`setDate(Calendar component2)` Set the Date (component2) from a Calendar object.
`Field34N`	`setDate(String component2)` Set the Date (component2).
`Field34N`	`setSign(String component1)` Set the Sign (component1).
`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, 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 34N
    
    See Also:
    Constant Field Values
  - F_34N
```
public static final String F_34N
```
    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
  - SIGN
```
public static final Integer SIGN
```
    Component number for the Sign subfield
  - DATE
```
public static final Integer DATE
```
    Component number for the Date subfield
  - CURRENCY
```
public static final Integer CURRENCY
```
    Component number for the Currency subfield
  - AMOUNT
```
public static final Integer AMOUNT
```
    Component number for the Amount subfield
- Constructor Detail
  - Field34N
```
public Field34N()
```
    Default constructor. Creates a new field setting all components to null.
  - Field34N
```
public Field34N(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
  - Field34N
```
public Field34N(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.
    
    Specified by:
    
    parse in class Field
    
    Parameters:
    value - complete field value including separators and CRLF
    Since:
    
    7.8
  - newInstance
```
public static Field34N newInstance(Field34N 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
  - getComponent1AsString
```
@Deprecated
public String getComponent1AsString()
```
    Deprecated.
    
    Same as getComponent(1)
  - getSign
```
public String getSign()
```
    Get the Sign (component1).
    
    Returns:
    the Sign from component1
  - setComponent1
```
public Field34N setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setSign
```
public Field34N setSign(String component1)
```
    Set the Sign (component1).
    
    Parameters:
    component1 - the Sign to set
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsCalendar
```
public Calendar getComponent2AsCalendar()
```
    Get the component2 as Calendar
    
    Returns:
    the component2 converted to Calendar or null if cannot be converted
  - getDate
```
public String getDate()
```
    Get the Date (component2).
    
    Returns:
    the Date from component2
  - getDateAsCalendar
```
public Calendar getDateAsCalendar()
```
    Get the Date (component2) as Calendar
    
    Returns:
    the Date from component2 converted to Calendar or null if cannot be converted
  - setComponent2
```
public Field34N setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setComponent2
```
public Field34N setComponent2(Calendar component2)
```
    Set the component2 from a Calendar object.
    Parses the Number into a SWIFT amount with truncated zero decimals and mandatory decimal separator.
    - Example: 1234.00 -> 1234,
    - Example: 1234 -> 1234,
    - Example: 1234.56 -> 1234,56
    Parameters:
    component2 - the Calendar with the component2 content to set
  - setDate
```
public Field34N setDate(String component2)
```
    Set the Date (component2).
    
    Parameters:
    component2 - the Date to set
  - setDate
```
public Field34N setDate(Calendar component2)
```
    Set the Date (component2) from a Calendar object.
    
    Parameters:
    component2 - Calendar with the Date content to set
    See Also:
    setComponent2(java.util.Calendar)
  - getComponent3
```
public String getComponent3()
```
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsCurrency
```
public Currency getComponent3AsCurrency()
```
    Get the component3 as Currency
    
    Returns:
    the component3 converted to Currency or null if cannot be converted
  - getCurrency
```
public String getCurrency()
```
    Get the Currency (component3).
    
    Returns:
    the Currency from component3
  - getCurrencyAsCurrency
```
public Currency getCurrencyAsCurrency()
```
    Get the Currency (component3) as Currency
    
    Returns:
    the Currency from component3 converted to Currency or null if cannot be converted
  - setComponent3
```
public Field34N setComponent3(String component3)
```
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setComponent3
```
public Field34N setComponent3(Currency component3)
```
    Set the component3 from a Currency object.
    Parses the Number into a SWIFT amount with truncated zero decimals and mandatory decimal separator.
    - Example: 1234.00 -> 1234,
    - Example: 1234 -> 1234,
    - Example: 1234.56 -> 1234,56
    Parameters:
    component3 - the Currency with the component3 content to set
  - setCurrency
```
public Field34N setCurrency(String component3)
```
    Set the Currency (component3).
    
    Parameters:
    component3 - the Currency to set
  - setCurrency
```
public Field34N setCurrency(Currency component3)
```
    Set the Currency (component3) from a Currency object.
    
    Parameters:
    component3 - Currency with the Currency content to set
    See Also:
    setComponent3(java.util.Currency)
  - getComponent4
```
public String getComponent4()
```
    Get the component4
    
    Returns:
    the component4
  - getComponent4AsNumber
```
public Number getComponent4AsNumber()
```
    Get the component4 as Number
    
    Returns:
    the component4 converted to Number or null if cannot be converted
  - getAmount
```
public String getAmount()
```
    Get the Amount (component4).
    
    Returns:
    the Amount from component4
  - getAmountAsNumber
```
public Number getAmountAsNumber()
```
    Get the Amount (component4) as Number
    
    Returns:
    the Amount from component4 converted to Number or null if cannot be converted
  - setComponent4
```
public Field34N setComponent4(String component4)
```
    Set the component4.
    
    Parameters:
    component4 - the component4 to set
  - setComponent4
```
public Field34N setComponent4(Number component4)
```
    Set the component4 from a Number object.
    Parses the Number into a SWIFT amount with truncated zero decimals and mandatory decimal separator.
    - Example: 1234.00 -> 1234,
    - Example: 1234 -> 1234,
    - Example: 1234.56 -> 1234,56
    Parameters:
    component4 - the Number with the component4 content to set
  - setAmount
```
public Field34N setAmount(String component4)
```
    Set the Amount (component4).
    
    Parameters:
    component4 - the Amount to set
  - setAmount
```
public Field34N setAmount(Number component4)
```
    Set the Amount (component4) from a Number object.
    
    Parameters:
    component4 - Number with the Amount content to set
    See Also:
    setComponent4(java.lang.Number)
  - currencyStrings
```
public List<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 List<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 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 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(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(Currency cur)
```
    Specified by:
    
    initializeCurrencies in interface CurrencyContainer
    
    See Also:
    CurrencyContainer.initializeCurrencies(String)
  - dates
```
public List<Calendar> dates()
```
    Description copied from interface: DateContainer
    
    Get a calendar for every date found
    
    Specified by:
    
    dates in interface DateContainer
  - amounts
```
public List<BigDecimal> amounts()
```
    See Also:
    AmountResolver#amounts(Field)}
  - amount
```
public BigDecimal amount()
```
    Description copied from interface: AmountContainer
    
    Get the first amount in this field.
    
    Specified by:
    
    amount in interface AmountContainer
    
    See Also:
    AmountResolver#amount(Field)}
  - 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 Field34N.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 Field34N.COMPONENTS_PATTERN
  - validatorPattern
```
public final String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field34N 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 Field34N get(SwiftMessage msg)
```
    Get the first instance of Field34N 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<Field34N> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field34N 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<Field34N> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field34N 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 Field34N

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_34N

PARSER_PATTERN

COMPONENTS_PATTERN

SIGN

DATE

CURRENCY

AMOUNT

Constructor Detail

Field34N

Field34N

Field34N

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsString

getSign

setComponent1

setSign

getComponent2

getComponent2AsCalendar

getDate

getDateAsCalendar

setComponent2

setComponent2

setDate

setDate

getComponent3

getComponent3AsCurrency

getCurrency

getCurrencyAsCurrency

setComponent3

setComponent3

setCurrency

setCurrency

getComponent4

getComponent4AsNumber

getAmount

getAmountAsNumber

setComponent4

setComponent4

setAmount

setAmount

currencyStrings

currencies

currency

currencyString

initializeCurrencies

initializeCurrencies

dates

amounts

amount

isOptional

isGeneric

parserPattern

getName

componentsPattern

validatorPattern

get

get

getAll

getAll

componentsSize

getValueDisplay

getComponentLabels