Field34H (Prowide Integrator API Reference)

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

All Implemented Interfaces:

AmountContainer, CurrencyContainer, MultiLineField, PatternContainer, Serializable

Deprecated.
```
@Deprecated
@Generated
public class Field34H
extends Field
implements Serializable, CurrencyContainer, AmountContainer, MultiLineField
```
Field 34H

validation pattern: [3!n$]<CUR><AMOUNT>15
parser pattern: [S$]SN
components pattern: NCN

Components Data types
- component1: Number
- component2: Currency
- component3: 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` Deprecated. Component number for the Amount subfield
`static String`	`COMPONENTS_PATTERN` Deprecated.
`static Integer`	`CURRENCY` Deprecated. Component number for the Currency subfield
`static String`	`F_34H` Deprecated. same as NAME, intended to be clear when using static imports
`static String`	`NAME` Deprecated. Constant with the field name 34H
`static String`	`PARSER_PATTERN` Deprecated.
`static int`	`SRU` Deprecated. 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
`Field34H()` Deprecated. Default constructor.
`Field34H(String value)` Deprecated. Creates a new field and initializes its components with content from the parameter value.
`Field34H(Tag tag)` Deprecated. 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()` Deprecated. Get the first amount in this field.
`List<BigDecimal>`	`amounts()` Deprecated.
`String`	`componentsPattern()` Deprecated. Returns the field's components pattern
`int`	`componentsSize()` Deprecated. 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()` Deprecated. Utility method that creates a Currency for every string returned by `CurrencyContainer.currencyStrings()`
`Currency`	`currency()` Deprecated. Analog to `CurrencyContainer.currencyString()`
`String`	`currencyString()` Deprecated. Get the single currency contained in this field.
`List<String>`	`currencyStrings()` Deprecated. Get a list of strings of currencies present in this field
`static Tag`	`emptyTag()` Deprecated. Create a Tag with this field name and an empty string as value Shorthand for `new Tag(NAME, "")`
`static Field34H`	`get(SwiftMessage msg)` Deprecated. Get the first instance of Field34H in the given message.
`static Field34H`	`get(SwiftTagListBlock block)` Deprecated. Get the first occurrence form the tag list or null if not found.
`static List<Field34H>`	`getAll(SwiftMessage msg)` Deprecated. Get a list of all occurrences of the field Field34H in the given message an empty list is returned if none found.
`static List<Field34H>`	`getAll(SwiftTagListBlock block)` Deprecated. Get a list of all occurrences of the field Field34H from the given block an empty list is returned if none found.
`String`	`getAmount()` Deprecated. Get the Amount (component3).
`Number`	`getAmountAsNumber()` Deprecated. Get the Amount (component3) as Number
`String`	`getComponent1()` Deprecated. Get the component1
`Number`	`getComponent1AsNumber()` Deprecated. Get the component1 as Number
`String`	`getComponent2()` Deprecated. Get the component2
`Currency`	`getComponent2AsCurrency()` Deprecated. Get the component2 as Currency
`String`	`getComponent3()` Deprecated. Get the component3
`Number`	`getComponent3AsNumber()` Deprecated. Get the component3 as Number
`protected List<String>`	`getComponentLabels()` Deprecated. Returns english label for components.
`String`	`getCurrency()` Deprecated. Get the Currency (component2).
`Currency`	`getCurrencyAsCurrency()` Deprecated. Get the Currency (component2) as Currency
`String`	`getLine(int line)` Deprecated. Returns a specific line from the field's value.
`String`	`getLine(int line, int offset)` Deprecated. Returns a specific line from the field's value.
`List<String>`	`getLines()` Deprecated. Returns the field value split into lines.
`List<String>`	`getLines(int offset)` Deprecated. Returns the field value starting at the offset component, split into lines.
`List<String>`	`getLinesBetween(int start, int end)` Deprecated. Returns a specific subset of lines from the field's value, given a range.
`List<String>`	`getLinesBetween(int start, int end, int offset)` Deprecated. Returns a specific subset of lines from the field's value, starting at the offset component.
`String`	`getName()` Deprecated. Returns the field's name composed by the field number and the letter option (if any)
`String`	`getValue()` Deprecated. Serializes the fields' components into the single string value (SWIFT format)
`String`	`getValueDisplay(int component, Locale locale)` Deprecated. Returns a localized suitable for showing to humans string of a field component.
`void`	`initializeCurrencies(Currency cur)` Deprecated.
`void`	`initializeCurrencies(String cur)` Deprecated. set the currency of this field.
`boolean`	`isGeneric()` Deprecated. Returns true if the field is a GENERIC FIELD as specified by the standard.
`boolean`	`isOptional(int component)` Deprecated. 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 Field34H`	`newInstance(Field34H source)` Deprecated. Copy constructor. Initializes the components list with a deep copy of the source components list.
`void`	`parse(String value)` Deprecated. Parses the parameter value into the internal components structure.
`String`	`parserPattern()` Deprecated.
`Field34H`	`setAmount(Number component3)` Deprecated. Set the Amount (component3) from a Number object.
`Field34H`	`setAmount(String component3)` Deprecated. Set the Amount (component3).
`Field34H`	`setComponent1(Number component1)` Deprecated. Set the component1 from a Number object.
`Field34H`	`setComponent1(String component1)` Deprecated. Set the component1.
`Field34H`	`setComponent2(Currency component2)` Deprecated. Set the component2 from a Currency object.
`Field34H`	`setComponent2(String component2)` Deprecated. Set the component2.
`Field34H`	`setComponent3(Number component3)` Deprecated. Set the component3 from a Number object.
`Field34H`	`setComponent3(String component3)` Deprecated. Set the component3.
`Field34H`	`setCurrency(Currency component2)` Deprecated. Set the Currency (component2) from a Currency object.
`Field34H`	`setCurrency(String component2)` Deprecated. Set the Currency (component2).
`static Tag`	`tag(String value)` Deprecated. Create a Tag with this field name and the given value.
`String`	`validatorPattern()` Deprecated. 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
```
    Deprecated.
    
    Constant identifying the SRU to which this class belongs to.
    
    See Also:
    Constant Field Values
  - NAME
```
public static final String NAME
```
    Deprecated.
    
    Constant with the field name 34H
    
    See Also:
    Constant Field Values
  - F_34H
```
public static final String F_34H
```
    Deprecated.
    
    same as NAME, intended to be clear when using static imports
    
    See Also:
    Constant Field Values
  - PARSER_PATTERN
```
public static final String PARSER_PATTERN
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - COMPONENTS_PATTERN
```
public static final String COMPONENTS_PATTERN
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - CURRENCY
```
public static final Integer CURRENCY
```
    Deprecated.
    
    Component number for the Currency subfield
  - AMOUNT
```
public static final Integer AMOUNT
```
    Deprecated.
    
    Component number for the Amount subfield
- Constructor Detail
  - Field34H
```
public Field34H()
```
    Deprecated.
    
    Default constructor. Creates a new field setting all components to null.
  - Field34H
```
public Field34H(String value)
```
    Deprecated.
    
    Creates a new field and initializes its components with content from the parameter value.
    
    Parameters:
    value - complete field value including separators and CRLF
  - Field34H
```
public Field34H(Tag tag)
```
    Deprecated.
    
    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)
```
    Deprecated.
    
    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 Field34H newInstance(Field34H source)
```
    Deprecated.
    
    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()
```
    Deprecated.
    
    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)
```
    Deprecated.
    
    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()
```
    Deprecated.
    
    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()
```
    Deprecated.
    
    Get the component1
    
    Returns:
    the component1
  - getComponent1AsNumber
```
public Number getComponent1AsNumber()
```
    Deprecated.
    
    Get the component1 as Number
    
    Returns:
    the component1 converted to Number or null if cannot be converted
  - setComponent1
```
public Field34H setComponent1(String component1)
```
    Deprecated.
    
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setComponent1
```
public Field34H setComponent1(Number component1)
```
    Deprecated.
    Set the component1 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:
    component1 - the Number with the component1 content to set
  - getComponent2
```
public String getComponent2()
```
    Deprecated.
    
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsCurrency
```
public Currency getComponent2AsCurrency()
```
    Deprecated.
    
    Get the component2 as Currency
    
    Returns:
    the component2 converted to Currency or null if cannot be converted
  - getCurrency
```
public String getCurrency()
```
    Deprecated.
    
    Get the Currency (component2).
    
    Returns:
    the Currency from component2
  - getCurrencyAsCurrency
```
public Currency getCurrencyAsCurrency()
```
    Deprecated.
    
    Get the Currency (component2) as Currency
    
    Returns:
    the Currency from component2 converted to Currency or null if cannot be converted
  - setComponent2
```
public Field34H setComponent2(String component2)
```
    Deprecated.
    
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setComponent2
```
public Field34H setComponent2(Currency component2)
```
    Deprecated.
    Set the component2 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:
    component2 - the Currency with the component2 content to set
  - setCurrency
```
public Field34H setCurrency(String component2)
```
    Deprecated.
    
    Set the Currency (component2).
    
    Parameters:
    component2 - the Currency to set
  - setCurrency
```
public Field34H setCurrency(Currency component2)
```
    Deprecated.
    
    Set the Currency (component2) from a Currency object.
    
    Parameters:
    component2 - Currency with the Currency content to set
    See Also:
    setComponent2(java.util.Currency)
  - getComponent3
```
public String getComponent3()
```
    Deprecated.
    
    Get the component3
    
    Returns:
    the component3
  - getComponent3AsNumber
```
public Number getComponent3AsNumber()
```
    Deprecated.
    
    Get the component3 as Number
    
    Returns:
    the component3 converted to Number or null if cannot be converted
  - getAmount
```
public String getAmount()
```
    Deprecated.
    
    Get the Amount (component3).
    
    Returns:
    the Amount from component3
  - getAmountAsNumber
```
public Number getAmountAsNumber()
```
    Deprecated.
    
    Get the Amount (component3) as Number
    
    Returns:
    the Amount from component3 converted to Number or null if cannot be converted
  - setComponent3
```
public Field34H setComponent3(String component3)
```
    Deprecated.
    
    Set the component3.
    
    Parameters:
    component3 - the component3 to set
  - setComponent3
```
public Field34H setComponent3(Number component3)
```
    Deprecated.
    Set the component3 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:
    component3 - the Number with the component3 content to set
  - setAmount
```
public Field34H setAmount(String component3)
```
    Deprecated.
    
    Set the Amount (component3).
    
    Parameters:
    component3 - the Amount to set
  - setAmount
```
public Field34H setAmount(Number component3)
```
    Deprecated.
    
    Set the Amount (component3) from a Number object.
    
    Parameters:
    component3 - Number with the Amount content to set
    See Also:
    setComponent3(java.lang.Number)
  - currencyStrings
```
public List<String> currencyStrings()
```
    Deprecated.
    
    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()
```
    Deprecated.
    
    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()
```
    Deprecated.
    
    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()
```
    Deprecated.
    
    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)
```
    Deprecated.
    
    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)
```
    Deprecated.
    
    Specified by:
    
    initializeCurrencies in interface CurrencyContainer
    
    See Also:
    CurrencyContainer.initializeCurrencies(String)
  - amounts
```
public List<BigDecimal> amounts()
```
    Deprecated.
    
    See Also:
    AmountResolver#amounts(Field)}
  - amount
```
public BigDecimal amount()
```
    Deprecated.
    
    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)
```
    Deprecated.
    
    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()
```
    Deprecated.
    
    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()
```
    Deprecated.
    
    Specified by:
    
    parserPattern in interface PatternContainer
  - getName
```
public String getName()
```
    Deprecated.
    
    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 Field34H.NAME
  - componentsPattern
```
public final String componentsPattern()
```
    Deprecated.
    
    Returns the field's components pattern
    
    Specified by:
    
    componentsPattern in interface PatternContainer
    
    Specified by:
    
    componentsPattern in class Field
    
    Returns:
    the static value of Field34H.COMPONENTS_PATTERN
  - validatorPattern
```
public final String validatorPattern()
```
    Deprecated.
    
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field34H get(SwiftTagListBlock block)
```
    Deprecated.
    
    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 Field34H get(SwiftMessage msg)
```
    Deprecated.
    
    Get the first instance of Field34H 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<Field34H> getAll(SwiftMessage msg)
```
    Deprecated.
    
    Get a list of all occurrences of the field Field34H 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<Field34H> getAll(SwiftTagListBlock block)
```
    Deprecated.
    
    Get a list of all occurrences of the field Field34H 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()
```
    Deprecated.
    
    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
  - getLine
```
public String getLine(int line)
```
    Deprecated.
    
    Returns a specific line from the field's value.
    
    Specified by:
    
    getLine in interface MultiLineField
    
    Parameters:
    line - a reference to a specific line in the field, first line being 1
    
    Returns:
    line content or null if not present or if line number is above the expected
    Since:
    
    7.7
    
    See Also:
    MultiLineField.getLine(int)
  - getLine
```
public String getLine(int line,
             int offset)
```
    Deprecated.
    
    Returns a specific line from the field's value.
    
    Specified by:
    
    getLine in interface MultiLineField
    
    Parameters:
    line - a reference to a specific line in the field, first line being 1
    offset - an optional component number used as offset when counting lines
    
    Returns:
    line content or null if not present or if line number is above the expected
    Since:
    
    7.7
    
    See Also:
    MultiLineField.getLine(int, int)
  - getLines
```
public List<String> getLines()
```
    Deprecated.
    
    Returns the field value split into lines.
    
    Specified by:
    
    getLines in interface MultiLineField
    
    Returns:
    lines content or empty list if field's value is empty
    Since:
    
    7.7
    
    See Also:
    MultiLineField.getLines()
  - getLines
```
public List<String> getLines(int offset)
```
    Deprecated.
    
    Returns the field value starting at the offset component, split into lines.
    
    Specified by:
    
    getLines in interface MultiLineField
    
    Parameters:
    offset - an optional component number used as offset when counting lines
    
    Returns:
    found lines or empty list if lines are not present or the offset is invalid
    Since:
    
    7.7
    
    See Also:
    MultiLineField.getLines(int)
  - getLinesBetween
```
public List<String> getLinesBetween(int start,
                           int end)
```
    Deprecated.
    
    Returns a specific subset of lines from the field's value, given a range.
    
    Specified by:
    
    getLinesBetween in interface MultiLineField
    
    Parameters:
    start - a reference to a specific line in the field, first line being 1
    end - a reference to a specific line in the field, must be greater than start
    
    Returns:
    found lines or empty list if value is empty
    Since:
    
    7.7
    
    See Also:
    MultiLineField.getLinesBetween(int, int )
  - getLinesBetween
```
public List<String> getLinesBetween(int start,
                           int end,
                           int offset)
```
    Deprecated.
    
    Returns a specific subset of lines from the field's value, starting at the offset component.
    
    Specified by:
    
    getLinesBetween in interface MultiLineField
    
    Parameters:
    start - a reference to a specific line in the field, first line being 1
    end - a reference to a specific line in the field, must be greater than start
    offset - an optional component number used as offset when counting lines
    
    Returns:
    found lines or empty list if lines are not present or the offset is invalid
    Since:
    
    7.7
    
    See Also:
    MultiLineField.getLinesBetween(int start, int end, int offset)
  - getValueDisplay
```
public String getValueDisplay(int component,
                     Locale locale)
```
    Deprecated.
    
    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()
```
    Deprecated.
    
    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 Field34H

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_34H

PARSER_PATTERN

COMPONENTS_PATTERN

CURRENCY

AMOUNT

Constructor Detail

Field34H

Field34H

Field34H

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsNumber

setComponent1

setComponent1

getComponent2

getComponent2AsCurrency

getCurrency

getCurrencyAsCurrency

setComponent2

setComponent2

setCurrency

setCurrency

getComponent3

getComponent3AsNumber

getAmount

getAmountAsNumber

setComponent3

setComponent3

setAmount

setAmount

currencyStrings

currencies

currency

currencyString

initializeCurrencies

initializeCurrencies

amounts

amount

isOptional

isGeneric

parserPattern

getName

componentsPattern

validatorPattern

get

get

getAll

getAll

componentsSize

getLine

getLine

getLines

getLines

getLinesBetween

getLinesBetween

getValueDisplay

getComponentLabels