Field (Prowide Integrator API Reference)

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

All Implemented Interfaces:

PatternContainer

Direct Known Subclasses:

Field101, Field102, Field103, Field104, Field105, Field106, Field107, Field108, Field109, Field110, Field113, Field114, Field115, Field116, Field117, Field118, Field119, Field11A, Field11R, Field11S, Field12, Field120, Field122, Field123, Field124, Field125, Field126, Field127, Field128, Field129, Field12A, Field12B, Field12C, Field12D, Field12E, Field12F, Field12G, Field130, Field132, Field133, Field134, Field135, Field136, Field137, Field13A, Field13B, Field13C, Field13D, Field13E, Field13J, Field13K, Field140, Field141, Field142, Field143, Field144, Field14A, Field14B, Field14C, Field14D, Field14F, Field14G, Field14J, Field14S, Field14T, Field151, Field152, Field153, Field15A, Field15B, Field15C, Field15D, Field15E, Field15F, Field15G, Field15H, Field15I, Field15J, Field15K, Field15L, Field15M, Field15N, Field15O, Field15P, Field16A, Field16C, Field16R, Field16S, Field171, Field172, Field173, Field174, Field175, Field177, Field179, Field17A, Field17B, Field17E, Field17F, Field17G, Field17H, Field17I, Field17L, Field17M, Field17N, Field17O, Field17P, Field17Q, Field17R, Field17S, Field17T, Field17U, Field17V, Field17W, Field17X, Field17Y, Field17Z, Field18A, Field18B, Field18C, Field18D, Field19, Field199, Field19A, Field19B, Field19C, Field19Y, Field19Z, Field20, Field202, Field203, Field204, Field206, Field208, Field209, Field20C, Field20D, Field20E, Field21, Field21A, Field21B, Field21C, Field21D, Field21E, Field21F, Field21G, Field21N, Field21P, Field21R, Field22, Field22A, Field22B, Field22C, Field22D, Field22E, Field22F, Field22G, Field22H, Field22J, Field22K, Field22L, Field22M, Field22N, Field22P, Field22Q, Field22R, Field22S, Field22T, Field22U, Field22V, Field22W, Field22X, Field22Y, Field22Z, Field23, Field23A, Field23B, Field23C, Field23D, Field23E, Field23F, Field23G, Field23X, Field242, Field243, Field24B, Field24D, Field24E, Field25, Field251, Field252, Field253, Field254, Field255, Field256, Field257, Field258, Field259, Field25A, Field25D, Field25P, Field260, Field263, Field264, Field26A, Field26B, Field26C, Field26D, Field26E, Field26F, Field26G, Field26H, Field26J, Field26K, Field26L, Field26N, Field26P, Field26T, Field27, Field270, Field271, Field272, Field27A, Field28, Field280, Field281, Field28C, Field28D, Field28E, Field29A, Field29B, Field29C, Field29D, Field29E, Field29F, Field29G, Field29H, Field29J, Field29K, Field29L, Field29M, Field29N, Field29S, Field30, Field301, Field302, Field303, Field304, Field305, Field307, Field30F, Field30G, Field30H, Field30J, Field30M, Field30N, Field30P, Field30Q, Field30S, Field30T, Field30U, Field30V, Field30X, Field30Y, Field30Z, Field311, Field312, Field313, Field31B, Field31C, Field31D, Field31E, Field31F, Field31G, Field31H, Field31J, Field31L, Field31P, Field31R, Field31S, Field31T, Field31X, Field329, Field32A, Field32B, Field32C, Field32D, Field32E, Field32F, Field32G, Field32H, Field32J, Field32K, Field32M, Field32N, Field32P, Field32Q, Field32R, Field32U, Field330, Field331, Field332, Field333, Field334, Field335, Field336, Field337, Field338, Field339, Field33A, Field33B, Field33C, Field33D, Field33E, Field33F, Field33G, Field33H, Field33J, Field33K, Field33N, Field33P, Field33R, Field33S, Field33T, Field33V, Field340, Field341, Field342, Field343, Field344, Field345, Field346, Field347, Field348, Field349, Field34A, Field34B, Field34C, Field34D, Field34E, Field34F, Field34G, Field34H, Field34J, Field34N, Field34P, Field34R, Field35A, Field35B, Field35C, Field35D, Field35E, Field35F, Field35H, Field35L, Field35N, Field35P, Field35S, Field35T, Field35U, Field36, Field36A, Field36B, Field36C, Field36E, Field37A, Field37B, Field37C, Field37D, Field37E, Field37F, Field37G, Field37H, Field37J, Field37K, Field37L, Field37M, Field37N, Field37P, Field37R, Field37S, Field37U, Field37V, Field38A, Field38B, Field38D, Field38E, Field38G, Field38H, Field38J, Field39A, Field39B, Field39C, Field39D, Field39P, Field401, Field405, Field40A, Field40B, Field40C, Field40E, Field40F, Field41A, Field41D, Field421, Field422, Field423, Field424, Field425, Field42A, Field42C, Field42D, Field42M, Field42P, Field431, Field432, Field433, Field434, Field43P, Field43T, Field443, Field44A, Field44B, Field44C, Field44D, Field44E, Field44F, Field451, Field45A, Field45B, Field461, Field46A, Field46B, Field47A, Field47B, Field48, Field49, Field49H, Field49J, Field50, Field503, Field50A, Field50B, Field50C, Field50D, Field50F, Field50G, Field50H, Field50K, Field50L, Field50M, Field51A, Field51C, Field51D, Field52A, Field52B, Field52C, Field52D, Field52G, Field533, Field53A, Field53B, Field53C, Field53D, Field53J, Field54A, Field54B, Field54D, Field55A, Field55B, Field55D, Field56A, Field56B, Field56C, Field56D, Field56J, Field57A, Field57B, Field57C, Field57D, Field57J, Field58A, Field58B, Field58C, Field58D, Field58J, Field59, Field59A, Field59F, Field60A, Field60B, Field60F, Field60M, Field61, Field619, Field62A, Field62B, Field62F, Field62M, Field64, Field65, Field67A, Field68A, Field68B, Field68C, Field69A, Field69B, Field69C, Field69D, Field69E, Field69F, Field69J, Field70, Field70C, Field70D, Field70E, Field70F, Field70G, Field71A, Field71B, Field71C, Field71D, Field71E, Field71F, Field71G, Field71H, Field71J, Field71K, Field71L, Field72, Field72C, Field73, Field74, Field75, Field76, Field77A, Field77B, Field77C, Field77D, Field77E, Field77F, Field77G, Field77H, Field77J, Field77K, Field77R, Field77S, Field77T, Field78, Field78B, Field79, Field80A, Field80B, Field80C, Field81A, Field81D, Field81J, Field82A, Field82B, Field82C, Field82D, Field82J, Field82S, Field83A, Field83C, Field83D, Field83J, Field83R, Field84A, Field84B, Field84D, Field84J, Field85A, Field85B, Field85C, Field85D, Field85J, Field86, Field86A, Field86B, Field86D, Field86J, Field87A, Field87B, Field87C, Field87D, Field87E, Field87F, Field87J, Field88A, Field88B, Field88C, Field88D, Field88J, Field89A, Field89D, Field89J, Field90A, Field90B, Field90C, Field90D, Field90E, Field90F, Field90J, Field90K, Field90L, Field90P, Field91A, Field91B, Field91C, Field91D, Field91E, Field91F, Field91G, Field91H, Field91J, Field92A, Field92B, Field92C, Field92D, Field92E, Field92F, Field92H, Field92J, Field92K, Field92L, Field92M, Field92N, Field92P, Field92R, Field93A, Field93B, Field93C, Field93D, Field94A, Field94B, Field94C, Field94D, Field94E, Field94F, Field94G, Field94H, Field94L, Field95C, Field95L, Field95P, Field95Q, Field95R, Field95S, Field95T, Field95U, Field95V, Field96A, Field96D, Field96J, Field97A, Field97B, Field97C, Field97E, Field98A, Field98B, Field98C, Field98D, Field98E, Field98F, Field98G, Field98H, Field98J, Field98K, Field999, Field99A, Field99B, Field99C
```
public abstract class Field
extends Object
implements PatternContainer
```
Base class implemented by classes that provide a general access to field components.

Since:

6.0

Author:

www.prowidesoftware.com

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<String>`	`components` Zero based list of field components in String format. For example: for field content ":FOO//EUR1234 will be components[0]=FOO, components[1]=EUR and components[1]=1234

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Field()` Deprecated. usar `Field(int)`
`protected`	`Field(Field source)` Copy constructor. Initializes the components list with a deep copy of the source components list.
`protected`	`Field(int components)` Creates a field with the list of components initialized to the given number of components.
`protected`	`Field(String value)` Creates a new field and initializes its components with content from the parameter value.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`appendInLines(StringBuilder sb, int componentStart, int componentEnd)` Append each component between componentStart and componentEnd in a new lines, empty components are ignored
`protected void`	`appendInLines(StringBuilder sb, String... lines)` Append each lines in a new lines, empty lines are ignored
`Tag`	`asTag()` Get the generic tag object of this field.
`abstract String`	`componentsPattern()` Returns the field's components pattern
`abstract 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.
`boolean`	`equals(Object obj)` Implementation of equals using EqualsBuilder from commons-lang
`String`	`findComponentStartingWith(String prefix)` Returns the first component starting with the given prefix value or `null` if not found.
`protected static String`	`format(Calendar d)`
`protected static String`	`formatAccount(String a)` A formatted amount with a fixed format nnnn-nnnnn-nnn-n
`protected static String`	`formatNumber(Object aValue)` Format the given object as a money number without currency information in format
`static BigDecimal`	`getAsBigDecimal(Number number)` Gets a BigDecimal from a generic Number argument
`String`	`getComponent(int number)` Gets a specific component from the components list.
`Object`	`getComponentAs(int component, Class c)` Get the given component as the given object type.
`Number`	`getComponentAsNumber(int component)` Get the given component as a number object This method internall y calls `getComponentAs(int, Class)`, and casts the result
`String`	`getComponentLabel(int number)` Returns english label for the component.
`protected abstract List<String>`	`getComponentLabels()` Returns english label for components.
`List<String>`	`getComponents()`
`String`	`getConditionalQualifier()` Deprecated.
`String`	`getDSS()` Deprecated.
`static Field`	`getField(String name, String value)` Creates a Field instance for the given it's name and and optional value, using reflection.
`static Field`	`getField(Tag t)` Creates a Field instance for the given Tag object, using reflection.
`String`	`getLabel()` Deprecated. field labels varies depending on the specific MT and sequence, label should be retrieve using `getLabel(String, String, String, Locale)` with proper MT and sequence identifiers
`String`	`getLabel(Locale locale)` Deprecated. field labels varies depending on the specific MT and sequence, label should be retrieve using `getLabel(String, String, String, Locale)` with proper MT and sequence identifiers
`static String`	`getLabel(String fieldName, Locale locale)` Deprecated. field labels varies depending on the specific MT and sequence, label should be retrieve using `getLabel(String, String, String, Locale)` with proper MT and sequence identifiers
`static String`	`getLabel(String fieldName, String mt, String sequence)` Same as `getLabel(String, String, String, Locale)` using default locale
`static String`	`getLabel(String fieldName, String mt, String sequence, Locale locale)` Returns the field business description name, using resource bundle from pw_swift_labels property files.
`static String`	`getLabelComponents(String fieldName, String mt, String sequence, Locale locale)` Similar to `getLabelComponents(String, String, String, Locale)` but returning the components property in bundle
`protected String`	`getLine(Field cp, Integer start, Integer end, int offset)` Base implementation for subclasses getLine API.
`abstract 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`	`getValueByCodeword(String codeword)` Finds the first component starting with the given codeword between slashes, and returns the component subvalue.
`String`	`getValueDisplay()`
`abstract String`	`getValueDisplay(int component, Locale locale)` Returns a localized suitable for showing to humans string of a field component.
`String`	`getValueDisplay(Locale locale)` Get a localized, suitable for showing to humans string of the field values.
`int`	`hashCode()` Implementation of hashCode using HashCodeBuilder from commons-lang
`protected void`	`init(int components)` Initialize the list of components to the indicated size and sets all values to `null`
`boolean`	`is(int componentNumber, String compare)` Compare the value of the component `componentNumber` of this field with `compare`
`boolean`	`is(String compare)` Compare the value of the component1 of this field with `compare` Same as `is(1, compare)`
`boolean`	`is(String compare1, String compare2)` Compare the value of the component1 of this field with `compare1` and the value of component2 with `compare2`
`boolean`	`isAnyOf(String... names)` Deprecated. confusing name, use `isNameAnyOf(String...)` instead
`boolean`	`isDSSPresent()` Deprecated.
`boolean`	`isEmpty()` Returns true if all field's components are blank or null
`abstract boolean`	`isGeneric()`
`boolean`	`isLetterOption(char c)` Tell if this field is of a given letter option.
`boolean`	`isNameAnyOf(String... names)`
`abstract boolean`	`isOptional(int component)`
`String`	`joinComponents()` Returns a string with all field's components joined.
`String`	`joinComponents(boolean skipLast)` Returns a string with all field's components joined.
`String`	`joinComponents(int start)` Returns a string with all field's components joined
`String`	`joinComponents(int start, boolean skipLast)` Returns a string with joined components values.
`Character`	`letterOption()` Return the letter option of this field as given by it classname or `null` if this field has no letter option
`void`	`parse(String value)` Parses the parameter value into the internal components structure.
`void`	`setComponent(int number, String value)` Inserts a component String value into the list of components, using the component number to position the value into the List.
`void`	`setComponents(List<String> components)`
`String`	`toString()` Implementation of toString using ToStringBuilder from commons-lang
`abstract String`	`validatorPattern()` Returns the field's validator pattern
`static boolean`	`validName(String name)` Returns true if the field name is valid.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.prowidesoftware.swift.model.field.PatternContainer
parserPattern

- Field Detail
  - components
```
protected List<String> components
```
    Zero based list of field components in String format.
    For example: for field content ":FOO//EUR1234 will be components[0]=FOO, components[1]=EUR and components[1]=1234
- Constructor Detail
  - Field
```
@Deprecated
protected Field()
```
    Deprecated. usar Field(int)
  - Field
```
protected Field(int components)
```
    Creates a field with the list of components initialized to the given number of components.
    
    Parameters:
    components - the number of components to initialize
    See Also:
    init(int)
  - Field
```
protected Field(String value)
```
    Creates a new field and initializes its components with content from the parameter value. The value is parsed with parse(String)
    
    Parameters:
    value - complete field value including separators and CRLF
  - Field
```
protected Field(Field 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
- Method Detail
  - init
```
protected void init(int components)
```
    Initialize the list of components to the indicated size and sets all values to null
    
    Parameters:
    components - the number of components to initialize
    Since:
    
    7.8
  - 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.
    Implemented by subclasses with logic for each specific field structure.
    
    Parameters:
    value - complete field value including separators and CRLF
    Since:
    
    7.8
  - toString
```
public String toString()
```
    Implementation of toString using ToStringBuilder from commons-lang
    
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Implementation of equals using EqualsBuilder from commons-lang
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Implementation of hashCode using HashCodeBuilder from commons-lang
    
    Overrides:
    
    hashCode in class Object
  - formatNumber
```
protected static String formatNumber(Object aValue)
```
    Format the given object as a money number without currency information in format
    
    Parameters:
    aValue -
    
    Returns:
    the formatted amount as String
  - format
```
protected static String format(Calendar d)
```
    Parameters:
    d - Date object to format
    
    Returns:
    the formatted date as dd/MM/yyyy or empty if exception occurs during formatting
  - formatAccount
```
protected static String formatAccount(String a)
```
    A formatted amount with a fixed format nnnn-nnnnn-nnn-n
    
    Parameters:
    a - string with an account number or null
    
    Returns:
    the formatted account or an empty String if param is null
  - appendInLines
```
protected void appendInLines(StringBuilder sb,
                 String... lines)
```
    Append each lines in a new lines, empty lines are ignored
    
    Parameters:
    sb - must not be null, target buffer
    lines - may be null or empty, nothing is done in this case
  - appendInLines
```
protected void appendInLines(StringBuilder sb,
                 int componentStart,
                 int componentEnd)
```
    Append each component between componentStart and componentEnd in a new lines, empty components are ignored
    
    Parameters:
    sb - must not be null, target buffer
    componentStart - starting component number to add
    componentEnd - ending component number to add
  - getComponents
```
public List<String> getComponents()
```
    Returns:
    comopnents list
  - setComponents
```
public void setComponents(List<String> components)
```
    Parameters:
    components - list to set
  - setComponent
```
public void setComponent(int number,
                String value)
```
    Inserts a component String value into the list of components, using the component number to position the value into the List.
    
    Parameters:
    number - component number, first component of a field should be number one
    value - String value of the parsed component (without component separators ':', '/', '//')
  - getComponent
```
public String getComponent(int number)
```
    Gets a specific component from the components list.
    
    Parameters:
    number - one-based index of component, first component of a field should be number one
    
    Returns:
    found component or null
  - getValueDisplay
```
public String getValueDisplay()
```
    See Also:
    getValueDisplay(Locale)
  - getValueDisplay
```
public String getValueDisplay(Locale locale)
```
    Get a localized, suitable for showing to humans string of the field values. This method is overwritten when necessary by subclasses.
    
    Parameters:
    locale - optional locale to format date and amounts, if null, the default locale is used
    
    Returns:
    a concatenation of formated components with " " separator
    Since:
    
    7.8
    
    See Also:
    getValueDisplay(int, Locale)
  - getValueDisplay
```
public abstract String getValueDisplay(int component,
                     Locale locale)
```
    Returns a localized suitable for showing to humans string of a field component.
    
    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
  - getComponentAs
```
public Object getComponentAs(int component,
                    Class c)
```
    Get the given component as the given object type. If the class is not recognized, it returns null, as well as if conversion fails.
    
    Parameters:
    component - one-based index of the component to retrieve
    
    Throws:
    
    IllegalArgumentException - if c is not any of: String, BIC, Currency, Number, BigDecimal Character or Integer
    See Also:
    getComponent(int)
  - getComponentAsNumber
```
public Number getComponentAsNumber(int component)
```
    Get the given component as a number object This method internall y calls getComponentAs(int, Class), and casts the result
    
    Since:
    
    7.8
  - joinComponents
```
public String joinComponents(int start,
                    boolean skipLast)
```
    Returns a string with joined components values.
    
    Parameters:
    start - starting index of components to join (zero based)
    skipLast - if true the last component will not be included in the join, and where the "last" component is understood as the last not empty component (this is not necessary the last component of the field's component list.
    
    Returns:
    s
  - joinComponents
```
public String joinComponents(boolean skipLast)
```
    Returns a string with all field's components joined.
    
    Parameters:
    skipLast -
    
    Returns:
    s
    See Also:
    joinComponents(int, boolean)
  - joinComponents
```
public String joinComponents(int start)
```
    Returns a string with all field's components joined
    
    Parameters:
    start -
    
    Returns:
    s
    See Also:
    joinComponents(int, boolean)
  - joinComponents
```
public String joinComponents()
```
    Returns a string with all field's components joined.
    
    Returns:
    s
    See Also:
    joinComponents(int, boolean)
  - getAsBigDecimal
```
public static BigDecimal getAsBigDecimal(Number number)
```
    Gets a BigDecimal from a generic Number argument
    
    Parameters:
    number -
    
    Returns:
    BigDecimal value of number parameter
  - findComponentStartingWith
```
public String findComponentStartingWith(String prefix)
```
    Returns the first component starting with the given prefix value or null if not found.
    
    Parameters:
    prefix -
    
    Returns:
    s
  - getValueByCodeword
```
public String getValueByCodeword(String codeword)
```
    Finds the first component starting with the given codeword between slashes, and returns the component subvalue. For example, for the following field value
    /ACC/BLABLABLA CrLf
    //BLABLABLA CrLf
    /INS/CITIUS33MIA CrLf
    //BLABLABLA CrLf
    A call to this method with parameter "INS" will return "CITIUS33MIA"
    
    Parameters:
    codeword -
    
    Returns:
    the found value or null if not found
    See Also:
    findComponentStartingWith(String)
  - getValue
```
public String getValue()
```
    Serializes the fields' components into the single string value (SWIFT format). Must be overwritten by by subclasses.
    
    Returns:
    SWIFT formatted value
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if all field's components are blank or null
    
    Returns:
    true if all field's components are blank or null
  - getField
```
public static Field getField(Tag t)
```
    Creates a Field instance for the given Tag object, using reflection. The created object is populated with parsed components data from the Tag.
    
    Parameters:
    t - a tag with proper name and value content
    
    Returns:
    a specific field object, ex: Field32A. Or null if exceptions occur during object creation.
  - getField
```
public static Field getField(String name,
             String value)
```
    Creates a Field instance for the given it's name and and optional value, using reflection.
    
    Parameters:
    name - a proper field name, ex: 32A, 22F, 20
    value - an optional field value or null to create the field with no initial content
    
    Returns:
    a specific field object, ex: Field32A. Or null if exceptions occur during object creation.
    Since:
    
    7.8
  - getLabel
```
@Deprecated
public String getLabel()
```
    Deprecated. field labels varies depending on the specific MT and sequence, label should be retrieve using getLabel(String, String, String, Locale) with proper MT and sequence identifiers
  - getLabel
```
@Deprecated
public String getLabel(Locale locale)
```
    Deprecated. field labels varies depending on the specific MT and sequence, label should be retrieve using getLabel(String, String, String, Locale) with proper MT and sequence identifiers
  - getLabel
```
@Deprecated
public static String getLabel(String fieldName,
                         Locale locale)
```
    Deprecated. field labels varies depending on the specific MT and sequence, label should be retrieve using getLabel(String, String, String, Locale) with proper MT and sequence identifiers
  - getLabel
```
public static String getLabel(String fieldName,
              String mt,
              String sequence)
```
    Same as getLabel(String, String, String, Locale) using default locale
    
    Since:
    
    7.8
  - getLabel
```
public static String getLabel(String fieldName,
              String mt,
              String sequence,
              Locale locale)
```
    Returns the field business description name, using resource bundle from pw_swift_labels property files. Field names may be generic for all usages, or may differ for particular letter option, message type or even sequence of a message type. The property supports all this kind of definitions with generic labels and specific ones. The following example illustrate the precedence of bundle keys that are checked for field 50:
    - 50K[103][B]
    - 50a[103][B]
    - 50K[103]
    - 50a[103]
    - 50K
    - 50a
    - 50
    Parameters:
    fieldName - field name of the field to retrieve its label, if the combination of number and letter option is provided then a specific label is returned; is the letter option is omitted then a more generic label is returned.
    mt - optional indication of message type or null.
    sequence - optional indication of sequence or null if does not apply for the specific MT and field.
    locale - the locale for which a resource bundle is desired
    
    Returns:
    a resource bundle based label for the given locale or the tag name, or the resource key if not found
  - getLabelComponents
```
public static String getLabelComponents(String fieldName,
                        String mt,
                        String sequence,
                        Locale locale)
```
    Similar to getLabelComponents(String, String, String, Locale) but returning the components property in bundle
    
    Since:
    
    7.8.4
  - getName
```
public abstract String getName()
```
    Returns the field's name composed by the field number and the letter option (if any)
    
    Returns:
    the static value of FieldNN.NAME
  - componentsPattern
```
public abstract String componentsPattern()
```
    Returns the field's components pattern
    
    Specified by:
    
    componentsPattern in interface PatternContainer
    
    Since:
    
    7.8
  - validatorPattern
```
public abstract String validatorPattern()
```
    Returns the field's validator pattern
    
    Since:
    
    7.8
  - isOptional
```
public abstract boolean isOptional(int component)
```
  - isGeneric
```
public abstract boolean isGeneric()
```
  - getDSS
```
@Deprecated
public String getDSS()
```
    Deprecated.
    
    Moved to GenericField Interface
  - isDSSPresent
```
@Deprecated
public boolean isDSSPresent()
```
    Deprecated.
    
    Moved to GenericField Interface
  - getConditionalQualifier
```
@Deprecated
public String getConditionalQualifier()
```
    Deprecated.
    
    Moved to GenericField Interface
  - letterOption
```
public Character letterOption()
```
    Return the letter option of this field as given by it classname or null if this field has no letter option
  - isLetterOption
```
public boolean isLetterOption(char c)
```
    Tell if this field is of a given letter option. letter is case sensitive
  - isAnyOf
```
@Deprecated
public boolean isAnyOf(String... names)
```
    Deprecated. confusing name, use isNameAnyOf(String...) instead
    
    Parameters:
    names - must not be null nor empty
    
    Returns:
    true if this field names equals one in the list of names and false in other case
    
    Throws:
    
    IllegalArgumentException - if names is null or empty
    See Also:
    isNameAnyOf(String...)
  - isNameAnyOf
```
public boolean isNameAnyOf(String... names)
```
    Parameters:
    names - must not be null nor empty
    
    Returns:
    true if this field names equals one in the list of names and false in other case
    
    Throws:
    
    IllegalArgumentException - if names is null or empty
  - is
```
public boolean is(String compare)
```
    Compare the value of the component1 of this field with compare Same as is(1, compare)
  - is
```
public boolean is(int componentNumber,
         String compare)
```
    Compare the value of the component componentNumber of this field with compare
  - is
```
public boolean is(String compare1,
         String compare2)
```
    Compare the value of the component1 of this field with compare1 and the value of component2 with compare2
  - asTag
```
public Tag asTag()
```
    Get the generic tag object of this field.
  - componentsSize
```
public abstract 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.
  - getLine
```
protected String getLine(Field cp,
             Integer start,
             Integer end,
             int offset)
```
    Base implementation for subclasses getLine API. Notice that line instance numbers are static and relevant to the field components definition, and not relative to the particular instance value. For example field 35B Line[1] will be the line with the ISIN number, regardless of the ISIN number present or not in the particular field instance. If that ISIN line is not present in the parameter field, the method will return null.
    
    Also notice that a line may be composed by several components, there is no linear relation between component numbers and lines numbers.
    
    Parameters:
    cp - a copy of the subclass (this object is altered during method execution)
    start - a reference to a specific line in the field, first line being 1; if null returns all found lines.
    end - a reference to a specific line in the field, first line being 1; if null returns all found lines.
    offset - an optional component number used as offset when counting lines
    
    Returns:
    found line content or null
  - validName
```
public static boolean validName(String name)
```
    Returns true if the field name is valid. Valid field names are for example: 20, 20C, 108
    
    Parameters:
    name - a field name to validate
    
    Returns:
    true if valid, false otherwise
    Since:
    
    7.8
  - getComponentLabels
```
protected abstract List<String> getComponentLabels()
```
    Returns english label for components.
    The index in the list is in sync with specific field component structure.
    
    Since:
    
    7.8.4
    
    See Also:
    getComponentLabel(int)
  - getComponentLabel
```
public String getComponentLabel(int number)
```
    Returns english label for the component.
    
    Parameters:
    number - one-based index of component, first component of a field should be number one
    
    Returns:
    found label or null if it is not defined
    Since:
    
    7.8.4

Class Field

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.prowidesoftware.swift.model.field.PatternContainer

Field Detail

components

Constructor Detail

Field

Field

Field

Field

Method Detail

init

parse

toString

equals

hashCode

formatNumber

format

formatAccount

appendInLines

appendInLines

getComponents

setComponents

setComponent

getComponent

getValueDisplay

getValueDisplay

getValueDisplay

getComponentAs

getComponentAsNumber

joinComponents

joinComponents

joinComponents

joinComponents

getAsBigDecimal

findComponentStartingWith

getValueByCodeword

getValue

isEmpty

getField

getField

getLabel

getLabel

getLabel

getLabel

getLabel

getLabelComponents

getName

componentsPattern

validatorPattern

isOptional

isGeneric

getDSS

isDSSPresent

getConditionalQualifier

letterOption

isLetterOption

isAnyOf

isNameAnyOf

is

is

is

asTag

componentsSize

getLine

validName

getComponentLabels

getComponentLabel