SwiftMessageUtils (Prowide Integrator API Reference)

java.lang.Object
- com.prowidesoftware.swift.model.SwiftMessageUtils

```
public class SwiftMessageUtils
extends Object
```
Utility methods that provide higher level access to SwiftMessage

Since:

6.0

Author:

www.prowidesoftware.com

Constructor Summary

Constructors
Constructor and Description

SwiftMessageUtils()

SwiftMessageUtils(SwiftMessage m)

Constructors
Constructor and Description
`SwiftMessageUtils()`
`SwiftMessageUtils(SwiftMessage m)`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`calculateChecksum(SwiftMessage model)` Proprietary checksum for message integrity verification.
`static SwiftTagListBlock`	`createSequenceSingle(Class<? extends AbstractMT> mt, String sequenceName, Tag... tags)`
`static SwiftTagListBlock`	`createSubsequenceWithParents(Class<? extends AbstractMT> mt, String sequenceName, Tag... tags)` Creates a sequence and all it's containing parents.
`List<String>`	`currencyStrings()`
`static List<String>`	`currencyStrings(SwiftMessage m)` Mirrors logic on `CurrencyContainer.currencyStrings()` including all fields
`static SwiftTagListBlock`	`join(List<? extends SwiftTagListBlock> sequences)` Joins all the given sequences in one single list.
`static String`	`reference(SwiftMessage m)` Gets the message reference from field 20 (if present) or from field 20C if message category is 5.
`static SwiftTagListBlock`	`removeInnerSequences(SwiftTagListBlock sequence)` Iterates through the parameter tags and removes all inner blocks enclosed between sequences boundary fields 16R and 16S This method requires a sequence starting with 16R and ending with 16S, so first and last tags must be those.
`static Map<String,SwiftTagListBlock>`	`splitByField15(SwiftMessage msg)` Split the given message by the field 15, returning the letter option in the field 15 as the key in the map.
`static List<SwiftTagListBlock>`	`splitByField15(SwiftMessage msg, String letterOption)` Helper method to retrieve all sequences starting with 15X where X is the letterOption parameter
`static Map<String,SwiftTagListBlock>`	`splitByField15(SwiftTagListBlock block)` Split the given block content by the field 15, returning the letter option in the field 15 as the key in the map
`static List<SwiftTagListBlock>`	`splitByField15(SwiftTagListBlock block, String letterOption)` Helper method to retrieve all sequences starting with 15X where X is the letterOption parameter.
`Calendar`	`valueDate()`
`static Calendar`	`valueDate(SwiftMessage m)` Gets the value date of a message. The value date is meaningful and defined by the standard only for a subset of message types.

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

- Constructor Detail
  - SwiftMessageUtils
```
public SwiftMessageUtils()
```
  - SwiftMessageUtils
```
public SwiftMessageUtils(SwiftMessage m)
```
- Method Detail
  - currencyStrings
```
public List<String> currencyStrings()
```
  - currencyStrings
```
public static List<String> currencyStrings(SwiftMessage m)
```
    Mirrors logic on CurrencyContainer.currencyStrings() including all fields
    
    Parameters:
    m -
    
    Returns:
    an empty list if none found
  - valueDate
```
public Calendar valueDate()
```
    See Also:
    valueDate(SwiftMessage)
  - removeInnerSequences
```
public static SwiftTagListBlock removeInnerSequences(SwiftTagListBlock sequence)
```
    Iterates through the parameter tags and removes all inner blocks enclosed between sequences boundary fields 16R and 16S
    This method requires a sequence starting with 16R and ending with 16S, so first and last tags must be those. Due to this constraint, null, empty and sequences with less than 3 tags will be returned without any modification.
    
    Parameters:
    sequence - a block with a sequence to filter
    
    Returns:
    a new block containing all tags that are outside a 16R/S block, the only 16R/S tags returned are the first and last delimiters.
    
    Throws:
    
    IllegalArgumentException - if the starting tag is not 16R or the ending tag is not the matching 16S
    Since:
    
    7.8.1
  - valueDate
```
public static Calendar valueDate(SwiftMessage m)
```
    Gets the value date of a message.
    
    The value date is meaningful and defined by the standard only for a subset of message types. In most of the cases it is contained in the date subfield of field 32A (for example MT103) or field 30 (for example MT101).
    Notice a lot of messages do not define a value date.
    Also a few define several fields as value date, or the value date can be repeated. for those messages the first one is returned as follows:
    - For MT450 returns the first value date occurrence of field 32A
    - For MT455 returns the value date from field 32A (not from 33[C,D])
    - For MT456 returns the first value date occurrence of field 33D
    - For MT564 returns the value date from Cash Movements Field 98a with qualifier PAYD (not qualifier VALU)
    Parameters:
    m - the message where the value date is to be found
    
    Returns:
    found date or null if the message does not defines a value date, or if the defined value date field is not present in the message
    Since:
    
    7.7
  - calculateChecksum
```
public static String calculateChecksum(SwiftMessage model)
```
    Proprietary checksum for message integrity verification. Please notice this is not the SWIFT trailer CHK field.
    
    Parameters:
    model -
    
    Returns:
    always null (this method is not yet implemented)
  - splitByField15
```
public static Map<String,SwiftTagListBlock> splitByField15(SwiftMessage msg)
```
    Split the given message by the field 15, returning the letter option in the field 15 as the key in the map.
    
    See Also:
    splitByField15(SwiftTagListBlock)
  - splitByField15
```
public static Map<String,SwiftTagListBlock> splitByField15(SwiftTagListBlock block)
```
    Split the given block content by the field 15, returning the letter option in the field 15 as the key in the map
    
    Parameters:
    block - the content to split
    
    Returns:
    a map with letter options as keys, and blocks as value
    Since:
    
    7.7
  - splitByField15
```
public static List<SwiftTagListBlock> splitByField15(SwiftMessage msg,
                                     String letterOption)
```
    Helper method to retrieve all sequences starting with 15X where X is the letterOption parameter
    
    Since:
    
    7.7
    
    See Also:
    splitByField15(SwiftTagListBlock, String)
  - splitByField15
```
public static List<SwiftTagListBlock> splitByField15(SwiftTagListBlock block,
                                     String letterOption)
```
    Helper method to retrieve all sequences starting with 15X where X is the letterOption parameter. Field 15a is used as a boundary for sequences, so the letter option correspond to a subsequence name.
    
    Parameters:
    block - the content to split into subsequences
    letterOption - a letter option for the field boundary
    
    Returns:
    found subsequences or an empty list if field 15 is not found
    Since:
    
    7.7
  - reference
```
public static String reference(SwiftMessage m)
```
    Gets the message reference from field 20 (if present) or from field 20C if message category is 5.
    
    Parameters:
    m - the message where the reference is to be found
    
    Returns:
    found reference or null if the message does not defines a reference, or if the defined reference field is not present in the message
    Since:
    
    7.8
  - join
```
public static SwiftTagListBlock join(List<? extends SwiftTagListBlock> sequences)
```
    Joins all the given sequences in one single list.
    
    Parameters:
    sequences - the sequences to be joined. Can be null or empty, in which case this method returns SwiftTagListBlock.EMPTY_LIST
    
    Returns:
    a single SwiftTagListBlock containing all elements in order of each of the given sequences or SwiftTagListBlock.EMPTY_LIST if sequences is null or empty
    Since:
    
    7.8
  - createSubsequenceWithParents
```
public static final SwiftTagListBlock createSubsequenceWithParents(Class<? extends AbstractMT> mt,
                                             String sequenceName,
                                             Tag... tags)
```
    Creates a sequence and all it's containing parents. This method is mainly useful for writing test cases. Instead of writing:
```
 MT535.SequenceB.newInstance(
                MT535.SequenceB1b.newInstance(
                        MT535.SequenceB1b.newInstance(
                                MT535.SequenceB1b1.newInstance(
                                        tags
                                )
                        )
                )
 );
 
```
    This method is the same with a much cleaner code literature:
```
        SwiftMessageUtils.createSequenceWithParents(MT535.class, "B1b1", tags);
 
```
    Note:
    Using
```
        SwiftMessageUtils.createSequenceWithParents(MT535.class, "B", tags);
 
```
    Is virtually the same as:
```
        MT535.SequenceB.newInstance(tags);
 
```
    Parameters:
    mt - the MT class for which the sequence is to be created
    sequenceName - name of the sequence
    tags - the content to put in the sequence
    
    Returns:
    the SwiftTagListBlock containing all parent sequences, the sequence requested and the contents
    Since:
    
    7.8
  - createSequenceSingle
```
public static SwiftTagListBlock createSequenceSingle(Class<? extends AbstractMT> mt,
                                     String sequenceName,
                                     Tag... tags)
```

Class SwiftMessageUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SwiftMessageUtils

SwiftMessageUtils

Method Detail

currencyStrings

currencyStrings

valueDate

removeInnerSequences

valueDate

calculateChecksum

splitByField15

splitByField15

splitByField15

splitByField15

reference

join

createSubsequenceWithParents

createSequenceSingle