Field71G (Prowide Integrator API Reference)

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

All Implemented Interfaces:

AmountContainer, CurrencyContainer, PatternContainer, Serializable
```
@Generated
public class Field71G
extends Field
implements Serializable, CurrencyContainer, AmountContainer
```
Field 71G

validation pattern: <CUR><AMOUNT>15
parser pattern: SN
components pattern: CN

Components Data types
- component1: Currency
- component2: 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 String`	`F_71G` same as NAME, intended to be clear when using static imports
`static String`	`NAME` Constant with the field name 71G
`static String`	`PARSER_PATTERN`
`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
`Field71G()` Default constructor.
`Field71G(String value)` Creates a new field and initializes its components with content from the parameter value.
`Field71G(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
`static Tag`	`emptyTag()` Create a Tag with this field name and an empty string as value Shorthand for `new Tag(NAME, "")`
`static Field71G`	`get(SwiftMessage msg)` Get the first instance of Field71G in the given message.
`static Field71G`	`get(SwiftTagListBlock block)` Get the first occurrence form the tag list or null if not found.
`static List<Field71G>`	`getAll(SwiftMessage msg)` Get a list of all occurrences of the field Field71G in the given message an empty list is returned if none found.
`static List<Field71G>`	`getAll(SwiftTagListBlock block)` Get a list of all occurrences of the field Field71G from the given block an empty list is returned if none found.
`String`	`getAmount()` Get the Amount (component2).
`Number`	`getAmountAsNumber()` Get the Amount (component2) as Number
`String`	`getComponent1()` Get the component1
`Currency`	`getComponent1AsCurrency()` Get the component1 as Currency
`String`	`getComponent2()` Get the component2
`Number`	`getComponent2AsNumber()` Get the component2 as Number
`protected List<String>`	`getComponentLabels()` Returns english label for components.
`String`	`getCurrency()` Get the Currency (component1).
`Currency`	`getCurrencyAsCurrency()` Get the Currency (component1) as Currency
`String`	`getName()` Returns the field's name composed by the field number and the letter option (if any)
`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 Field71G`	`newInstance(Field71G 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()`
`Field71G`	`setAmount(Number component2)` Set the Amount (component2) from a Number object.
`Field71G`	`setAmount(String component2)` Set the Amount (component2).
`Field71G`	`setComponent1(Currency component1)` Set the component1 from a Currency object.
`Field71G`	`setComponent1(String component1)` Set the component1.
`Field71G`	`setComponent2(Number component2)` Set the component2 from a Number object.
`Field71G`	`setComponent2(String component2)` Set the component2.
`Field71G`	`setCurrency(Currency component1)` Set the Currency (component1) from a Currency object.
`Field71G`	`setCurrency(String component1)` Set the Currency (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, 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 71G
    
    See Also:
    Constant Field Values
  - F_71G
```
public static final String F_71G
```
    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
  - 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
  - Field71G
```
public Field71G()
```
    Default constructor. Creates a new field setting all components to null.
  - Field71G
```
public Field71G(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
  - Field71G
```
public Field71G(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.
    
    Overrides:
    
    parse in class Field
    
    Parameters:
    value - complete field value including separators and CRLF
    Since:
    
    7.8
  - newInstance
```
public static Field71G newInstance(Field71G 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
  - getComponent1AsCurrency
```
public Currency getComponent1AsCurrency()
```
    Get the component1 as Currency
    
    Returns:
    the component1 converted to Currency or null if cannot be converted
  - getCurrency
```
public String getCurrency()
```
    Get the Currency (component1).
    
    Returns:
    the Currency from component1
  - getCurrencyAsCurrency
```
public Currency getCurrencyAsCurrency()
```
    Get the Currency (component1) as Currency
    
    Returns:
    the Currency from component1 converted to Currency or null if cannot be converted
  - setComponent1
```
public Field71G setComponent1(String component1)
```
    Set the component1.
    
    Parameters:
    component1 - the component1 to set
  - setComponent1
```
public Field71G setComponent1(Currency component1)
```
    Set the component1 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:
    component1 - the Currency with the component1 content to set
  - setCurrency
```
public Field71G setCurrency(String component1)
```
    Set the Currency (component1).
    
    Parameters:
    component1 - the Currency to set
  - setCurrency
```
public Field71G setCurrency(Currency component1)
```
    Set the Currency (component1) from a Currency object.
    
    Parameters:
    component1 - Currency with the Currency content to set
    See Also:
    setComponent1(java.util.Currency)
  - getComponent2
```
public String getComponent2()
```
    Get the component2
    
    Returns:
    the component2
  - getComponent2AsNumber
```
public Number getComponent2AsNumber()
```
    Get the component2 as Number
    
    Returns:
    the component2 converted to Number or null if cannot be converted
  - getAmount
```
public String getAmount()
```
    Get the Amount (component2).
    
    Returns:
    the Amount from component2
  - getAmountAsNumber
```
public Number getAmountAsNumber()
```
    Get the Amount (component2) as Number
    
    Returns:
    the Amount from component2 converted to Number or null if cannot be converted
  - setComponent2
```
public Field71G setComponent2(String component2)
```
    Set the component2.
    
    Parameters:
    component2 - the component2 to set
  - setComponent2
```
public Field71G setComponent2(Number component2)
```
    Set the component2 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:
    component2 - the Number with the component2 content to set
  - setAmount
```
public Field71G setAmount(String component2)
```
    Set the Amount (component2).
    
    Parameters:
    component2 - the Amount to set
  - setAmount
```
public Field71G setAmount(Number component2)
```
    Set the Amount (component2) from a Number object.
    
    Parameters:
    component2 - Number with the Amount content to set
    See Also:
    setComponent2(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)
  - amounts
```
public List<BigDecimal> amounts()
```
  - amount
```
public 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
  - 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 Field71G.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 Field71G.COMPONENTS_PATTERN
  - validatorPattern
```
public final String validatorPattern()
```
    Returns the field's validators pattern
    
    Specified by:
    
    validatorPattern in class Field
  - get
```
public static Field71G 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 Field71G get(SwiftMessage msg)
```
    Get the first instance of Field71G 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<Field71G> getAll(SwiftMessage msg)
```
    Get a list of all occurrences of the field Field71G 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<Field71G> getAll(SwiftTagListBlock block)
```
    Get a list of all occurrences of the field Field71G 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 Field71G

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_71G

PARSER_PATTERN

COMPONENTS_PATTERN

CURRENCY

AMOUNT

Constructor Detail

Field71G

Field71G

Field71G

Method Detail

parse

newInstance

getValue

tag

emptyTag

getComponent1

getComponent1AsCurrency

getCurrency

getCurrencyAsCurrency

setComponent1

setComponent1

setCurrency

setCurrency

getComponent2

getComponent2AsNumber

getAmount

getAmountAsNumber

setComponent2

setComponent2

setAmount

setAmount

currencyStrings

currencies

currency

currencyString

initializeCurrencies

initializeCurrencies

amounts

amount

isOptional

isGeneric

parserPattern

getName

componentsPattern

validatorPattern

get

get

getAll

getAll

componentsSize

getValueDisplay

getComponentLabels