SwiftParseUtils (Prowide Integrator API Reference)

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

```
public class SwiftParseUtils
extends Object
```
This class provides methods to parse field components.

Since:

6.0

Author:

www.prowidesoftware.com

Constructor Summary

Constructors
Constructor and Description

SwiftParseUtils()

Constructors
Constructor and Description
`SwiftParseUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`getAlphaPrefix(String value)` Returns the alphabetic starting substring of the value.
`static String`	`getAlphaSuffix(String value)` Returns the alpha suffix of the value.
`static List<String>`	`getLines(String value)` Separate the given string in lines using readline
`static String`	`getNumericPrefix(String value)` Returns the numeric starting substring of the value.
`static String`	`getNumericSuffix(String value)` Returns the numeric suffix of the value.
`static String`	`getTokenFirst(String line, String separator)`
`static String`	`getTokenFirst(String line, String starting, String separator)` Split components of a line with an optional starting string and a component separator and returns the first token found or `null` if the string without starting substring is empty or `null`. This method does not validate the starting string presence, it just strips it if present.
`static String`	`getTokenForth(String line, String separator)` Split components of a line using the parameter separator and returns the forth token found or `null` if forth component is missing.
`static String`	`getTokenForthLast(String line, String separator)` Split components of a line using the parameter separator and returns the forth token found or `null` if forth component is missing.
`static String`	`getTokenSecond(String line, String separator)` Split components of a line using the parameter separator and returns the second token found or `null` if second component is missing.
`static String`	`getTokenSecond(String line, String starting, String separator)` Split components of a line with an optional starting string and a component separator and returns the second token found or `null` if the string without starting substring is empty or `null`. This method does not validate the starting string presence, it just strips it if present.
`static String`	`getTokenSecondLast(String line, String separator)` Split components of a line using the parameter separator and returns the second token found or `null` if second component is missing.
`static String`	`getTokenSecondLast(String line, String starting, String separator)` Split components of a line with an optional starting string and a component separator and returns the second token found or `null` if the string without starting substring is empty or `null`.
`static String`	`getTokenThird(String line, String separator)` Split components of a line using the parameter separator and returns the third token found or `null` if third component is missing.
`static String`	`getTokenThirdLast(String line, String separator)` Split components of a line using the parameter separator and returns the third token found or `null` if third component is missing.
`static String`	`removePrefix(String value, String prefix)`
`static void`	`setComponentsFromLines(Field f, int startingComponentNumber, int linesToSet, int startingLine, List<String> lines)` Populates a multiline field with content from an array of Strings.
`static void`	`setComponentsFromTokens(Field f, int startingComponentNumber, int componentsToSet, int tokenSize, String value)` Populates field with content from of a String splited into fixed length tokens.
`static List<String>`	`splitComponents(String line, String starting, String separator)` Split components of a line, with an optional starting string and a component separator.

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

- Constructor Detail
  - SwiftParseUtils
```
public SwiftParseUtils()
```
- Method Detail
  - splitComponents
```
public static List<String> splitComponents(String line,
                           String starting,
                           String separator)
```
    Split components of a line, with an optional starting string and a component separator. Adjacent separators are treated as one separator. This method does not validate the starting string presence, it just strips it if present. this methods uses StringUtils.splitByWholeSeparator(String, String)
    
    Parameters:
    line - the string to parse
    starting - an optional starting string
    separator - the components separator
    
    Returns:
    a list of String with the found components or an empty list if none is found
  - getTokenFirst
```
public static String getTokenFirst(String line,
                   String starting,
                   String separator)
```
    Split components of a line with an optional starting string and a component separator and returns the first token found or null if the string without starting substring is empty or null.
    This method does not validate the starting string presence, it just strips it if present.
    
    Parameters:
    line -
    starting -
    separator -
    
    Returns:
    the first token found or null
  - getTokenFirst
```
public static String getTokenFirst(String line,
                   String separator)
```
    Parameters:
    line -
    separator -
    
    Returns:
    found token
    See Also:
    getTokenFirst(String, String, String)
  - removePrefix
```
public static String removePrefix(String value,
                  String prefix)
```
    Parameters:
    value -
    prefix -
    
    Returns:
    s
  - getTokenSecond
```
public static String getTokenSecond(String line,
                    String separator)
```
    Split components of a line using the parameter separator and returns the second token found or null if second component is missing. Two adjacent separators are NOT treated as one.
    Examples with slash as separator:
    - for the literal "abc//def/ghi" will return null.
    - for the literal "abc/foo/def" will return "foo".
    - for the literal "abc/foo/def/ghi" will return "foo".
    Parameters:
    line -
    separator -
    
    Returns:
    s
  - getTokenSecondLast
```
public static String getTokenSecondLast(String line,
                        String separator)
```
    Split components of a line using the parameter separator and returns the second token found or null if second component is missing. Two adjacent separators are NOT treated as one. The second component is assumed as the last one so its content may have additional separators if present.
    Examples with slash as separator:
    - for the literal "abc//def/ghi" will return null.
    - for the literal "abc/foo" will return "foo".
    - for the literal "abc/foo/def/ghi" will return "foo/def/ghi".
    Parameters:
    line -
    separator -
    
    Returns:
    s
  - getTokenSecond
```
public static String getTokenSecond(String line,
                    String starting,
                    String separator)
```
    Split components of a line with an optional starting string and a component separator and returns the second token found or null if the string without starting substring is empty or null.
    This method does not validate the starting string presence, it just strips it if present.
    
    Parameters:
    line -
    starting -
    separator -
    
    Returns:
    the second token found or null
    Since:
    
    7.4
  - getTokenSecondLast
```
public static String getTokenSecondLast(String line,
                        String starting,
                        String separator)
```
    Split components of a line with an optional starting string and a component separator and returns the second token found or null if the string without starting substring is empty or null.
    Two adjacent separators are NOT treated as one. The second component is assumed as the last one so its content may have additional separators if present.
    This method does not validate the starting string presence, it just strips it if present.
    
    Parameters:
    line -
    starting -
    separator -
    
    Returns:
    the second token found or null
    Since:
    
    7.4
  - getTokenThird
```
public static String getTokenThird(String line,
                   String separator)
```
    Split components of a line using the parameter separator and returns the third token found or null if third component is missing. Two adjacent separators are NOT treated as one.
    Examples with slash as separator:
    - for the literal "abc/def//ghi" will return null.
    - for the literal "abc/foo" will return "null".
    - for the literal "abc/def/foo" will return "foo".
    - for the literal "abc/def/foo/ghi" will return "foo".
    Parameters:
    line -
    separator -
    
    Returns:
    s
  - getTokenThirdLast
```
public static String getTokenThirdLast(String line,
                       String separator)
```
    Split components of a line using the parameter separator and returns the third token found or null if third component is missing. Two adjacent separators are NOT treated as one. The third component is assumed as the last one so its content may have additional separators if present.
    Examples with slash as separator:
    - for the literal "abc/def//ghi" will return null.
    - for the literal "abc/foo" will return "null".
    - for the literal "abc/def/foo" will return "foo".
    - for the literal "abc/def/foo/ghi" will return "foo/ghi".
    Parameters:
    line -
    separator -
    
    Returns:
    s
  - getTokenForth
```
public static String getTokenForth(String line,
                   String separator)
```
    Split components of a line using the parameter separator and returns the forth token found or null if forth component is missing. Two adjacent separators are NOT treated as one.
    Examples with slash as separator:
    - for the literal "abc/def/ghi//ghi" will return null.
    - for the literal "abc/foo/ghi" will return "null".
    - for the literal "abc/def/ghi/foo" will return "foo".
    - for the literal "abc/def/ghi/foo/ghi" will return "foo".
    Parameters:
    line -
    separator -
    
    Returns:
    s
  - getTokenForthLast
```
public static String getTokenForthLast(String line,
                       String separator)
```
    Split components of a line using the parameter separator and returns the forth token found or null if forth component is missing. Two adjacent separators are NOT treated as one. The forth component is assumed as the last one so its content may have additional separators if present.
    Examples with slash as separator:
    - for the literal "abc/def/ghi//ghi" will return null.
    - for the literal "abc/foo/ghi" will return "null".
    - for the literal "abc/def/ghi/foo" will return "foo".
    - for the literal "abc/def/ghi/foo/ghi" will return "foo/ghi".
    Parameters:
    line -
    separator -
    
    Returns:
    s
  - getAlphaPrefix
```
public static String getAlphaPrefix(String value)
```
    Returns the alphabetic starting substring of the value. The split is made when the first numeric character is found. For example:
    ABCD2345,33 will be return ABCD
    If the value does not contain any alphabetic character null is returned.
    
    Parameters:
    value -
    
    Returns:
    s
  - getNumericPrefix
```
public static String getNumericPrefix(String value)
```
    Returns the numeric starting substring of the value. The split is made when the first alpha character (not number or comma) is found. For example:
    2345,33ABCD will be return 2345,33
    If the value does not contain any numeric or comma character null is returned.
    
    Parameters:
    value -
    
    Returns:
    s
  - getNumericSuffix
```
public static String getNumericSuffix(String value)
```
    Returns the numeric suffix of the value. The split is made when the first numeric character is found. For example:
    ABCD2345,33 will be return 2345,33
    If the value does not contain any numeric character null is returned.
    
    Parameters:
    value -
    
    Returns:
    s
  - getAlphaSuffix
```
public static String getAlphaSuffix(String value)
```
    Returns the alpha suffix of the value. The split is made when the first alpha (not numetic or comma) character is found. For example:
    2345,33ABCD will be return ABCD
    If the value does not contain any alpha character null is returned.
    
    Parameters:
    value -
    
    Returns:
    s
  - getLines
```
public static List<String> getLines(String value)
```
    Separate the given string in lines using readline
    
    Parameters:
    value -
    
    Returns:
    list of found lines
  - setComponentsFromLines
```
public static void setComponentsFromLines(Field f,
                          int startingComponentNumber,
                          int linesToSet,
                          int startingLine,
                          List<String> lines)
```
    Populates a multiline field with content from an array of Strings.
    
    Parameters:
    f - field to populate with components' values
    startingComponentNumber - first component number to be set, then it will increment on each line added
    linesToSet - how many components must to be set
    startingLine - lines list offset, zero based
    lines - list of lines from where to get components content
  - setComponentsFromTokens
```
public static void setComponentsFromTokens(Field f,
                           int startingComponentNumber,
                           int componentsToSet,
                           int tokenSize,
                           String value)
```
    Populates field with content from of a String splited into fixed length tokens.
    
    Parameters:
    f - field to populate with components' values
    startingComponentNumber - first component number to be set, then it will increment on each token added
    componentsToSet - how many components must to be set
    tokenSize - fixed size for each token grabbed from the String value
    value - from where to get components content
    Since:
    
    7.4

Class SwiftParseUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SwiftParseUtils

Method Detail

splitComponents

getTokenFirst

getTokenFirst

removePrefix

getTokenSecond

getTokenSecondLast

getTokenSecond

getTokenSecondLast

getTokenThird

getTokenThirdLast

getTokenForth

getTokenForthLast

getAlphaPrefix

getNumericPrefix

getNumericSuffix

getAlphaSuffix

getLines

setComponentsFromLines

setComponentsFromTokens