SwiftFormatUtils

java.lang.Object
- com.prowidesoftware.swift.utils.SwiftFormatUtils

```
public class SwiftFormatUtils
extends Object
```
This class provides methods to convert field components to objects. It handles for example; dates, currencies and general functions defined in the SWIFT standard.
- DATE1 MMDD
- DATE2 YYMMDD
- DATE3 YYMM
- DATE4 YYYYMMDD
- YEAR YYYY
- AMOUNT ###,### (digits with comma as decimal separator)
- TIME2 HHmmss
- TIME3 HH[mm]
- BOOL Y/N
- DATETIME YYYYMMDDHHMM
- DATETIME with short year YYMMDDHHMM
- DAYTIME DDHHMM
- MONTHDAY MMDD
- MIR
- MOR
Since:

6.0

Author:

www.prowidesoftware.com

Constructor Summary

Constructors
Constructor and Description

SwiftFormatUtils()

Constructors
Constructor and Description
`SwiftFormatUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`getBIC(BIC bic)` Gets the code from the parameter BIC.
`static BIC`	`getBIC(String code)`
`static String`	`getBoolean(Boolean bool)` Parses a Boolean object into a string.
`static Boolean`	`getBoolean(String string)` Gets the given string as boolean.
`static String`	`getCurrency(Currency currency)` Gets the currency code from the parameter Currency.
`static Currency`	`getCurrency(String code)` Returns the `Currency` instance for the given currency code.
`static String`	`getDate1(Calendar date)` Parses a Calendar object into a DATE1 string.
`static Calendar`	`getDate1(String strDate)` Parses a DATE1 string (accept dates in format MMDD) into a Calendar object.
`static String`	`getDate2(Calendar date)` Parses a Calendar object into a DATE2 string.
`static Calendar`	`getDate2(String strDate)` Parses a DATE2 string (accept dates in format YYMMDD) into a Calendar object.
`static String`	`getDate3(Calendar date)` Parses a Calendar object into a DATE1 string.
`static Calendar`	`getDate3(String strDate)` Parses a DATE3 string (accept dates in format YYMM) into a Calendar object.
`static String`	`getDate4(Calendar date)` Parses a Calendar object into a DATE1 string.
`static Calendar`	`getDate4(String strDate)` Parses a DATE4 string (accept dates in format YYYYMMDD) into a Calendar object.
`static String`	`getDateTime(Calendar date)` Parses a Calendar object into a string containing the DATETIME with YYYYMMDDHHMM format.
`static Calendar`	`getDateTime(String strDate)` Parses a DATETIME string (accepts dates with time in YYYYMMDDHHMM format) into a Calendar object.
`static String`	`getDateTimeShortYear(Calendar date)` Parses a Calendar object into a DATETIME with short year string in YYMMDDHHMM format.
`static Calendar`	`getDateTimeShortYear(String strDate)` Parses a DATETIME with short year string (accepts dates with time in YYMMDDHHMM format) into a Calendar object.
`static String`	`getDayTime(Calendar date)` Parses a Calendar object into a string containing the DAYTIME in DDHHMM format.
`static Calendar`	`getDayTime(String strDate)` Parses a DAYTIME string (accepts dates with time in DDHHMM format) into a Calendar object.
`static Calendar`	`getHhmm(String hhmm)`
`static String`	`getHour(Calendar date)` Parses a Calendar object into a string containing the HOUR in HH format.
`static Calendar`	`getHour(String strDate)` Parses an HOUR string (accepts time in HH format) into a Calendar object.
`static String`	`getMIR(MIR mir)` Parses a MIR object into a string containing its serialized data.
`static MIR`	`getMIR(String value)` Parses a string value into a MIR object.
`static String`	`getMonthDay(Calendar date)` Parses a Calendar object into a string containing MONTHDAY in MMDD format.
`static Calendar`	`getMonthDay(String strDate)` Parses a MONTHDAY string (accepts dates in MMDD format) into a Calendar object.
`static String`	`getMOR(MOR mor)` Parses a MOR object into a string containing its serialized data.
`static MOR`	`getMOR(String value)` Parses a string value into a MOR object.
`static String`	`getNumber(Number number)` Parses a Number into a SWIFT string number ####,## where trunked zero decimals and mandatory decimal separator.
`static Number`	`getNumber(String amount)` Parses a value into a java Number (BigDecimal) using the comma for decimal separator.
`static String`	`getOffset(Calendar date)` Parses a Calendar object into a offset string.
`static Calendar`	`getOffset(String string)`
`static Character`	`getSign(String string)`
`static String`	`getTime2(Calendar date)` Parses a Calendar object into a TIME2 string.
`static Calendar`	`getTime2(String hhmmss)`
`static String`	`getTime3(Calendar date)` Parses a Calendar object into a TIME3 string.
`static Calendar`	`getTime3(String hhmmss)`
`static String`	`getYear(Calendar date)` Parses a Calendar object into a YYYY string.
`static Calendar`	`getYear(String strDate)` Parses a YEAR string (accept dates in format YYYY) into a Calendar object.
`static boolean`	`isCurrency(String string)` Tell if `string` is a valid currency code

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

- Constructor Detail
  - SwiftFormatUtils
```
public SwiftFormatUtils()
```
- Method Detail
  - getBIC
```
public static String getBIC(BIC bic)
```
    Gets the code from the parameter BIC.
    
    Parameters:
    bic - BIC to use
    
    Returns:
    the string with the BIC code
    Since:
    
    6.4
  - getBIC
```
public static BIC getBIC(String code)
```
    Parameters:
    code - string with a BIC code
    
    Returns:
    a BIC initialized from the parameter code
  - getBoolean
```
public static String getBoolean(Boolean bool)
```
    Parses a Boolean object into a string.
    
    Parameters:
    bool - Boolean to parse
    
    Returns:
    parsed boolean converted to "Y" or "N" or null if the boolean object is null
    Since:
    
    7.4
  - getBoolean
```
public static Boolean getBoolean(String string)
```
    Gets the given string as boolean.
    
    Parameters:
    string - code to use where the expected values are "Y" or "N"
    
    Returns:
    true for "Y", false for "N", and null otherwise
    Since:
    
    7.4
  - getCurrency
```
public static String getCurrency(Currency currency)
```
    Gets the currency code from the parameter Currency.
    
    Parameters:
    currency - Currency to use
    
    Returns:
    the string with the currency code
    Since:
    
    6.4
  - getCurrency
```
public static Currency getCurrency(String code)
```
    Returns the Currency instance for the given currency code.
    
    Parameters:
    code - string with a currency code
    
    Returns:
    a Currency initialized from the parameter code
    
    Throws:
    
    IllegalArgumentException - if currencyCode is not a supported ISO 4217 code.
  - getDate1
```
public static String getDate1(Calendar date)
```
    Parses a Calendar object into a DATE1 string.
    
    Parameters:
    date - Calendar to parse
    
    Returns:
    parsed date or null if the calendar is null
    Since:
    
    6.4
  - getDate1
```
public static Calendar getDate1(String strDate)
```
    Parses a DATE1 string (accept dates in format MMDD) into a Calendar object.
    
    Parameters:
    strDate - string to parse
    
    Returns:
    parsed date or null if the argument did not matched the expected date format
  - getDate2
```
public static String getDate2(Calendar date)
```
    Parses a Calendar object into a DATE2 string.
    
    Parameters:
    date - Calendar to parse
    
    Returns:
    parsed date or null if the calendar is null
  - getDate2
```
public static Calendar getDate2(String strDate)
```
    Parses a DATE2 string (accept dates in format YYMMDD) into a Calendar object.
    
    Parameters:
    strDate - string to parse
    
    Returns:
    parsed date or null if the argument did not matched the expected date format
  - getDate3
```
public static String getDate3(Calendar date)
```
    Parses a Calendar object into a DATE1 string.
    
    Parameters:
    date - Calendar to parse
    
    Returns:
    parsed date or null if the calendar is null
    Since:
    
    6.4
  - getDate3
```
public static Calendar getDate3(String strDate)
```
    Parses a DATE3 string (accept dates in format YYMM) into a Calendar object.
    
    Parameters:
    strDate - string to parse
    
    Returns:
    parsed date or null if the argument did not matched the expected date format
  - getDate4
```
public static String getDate4(Calendar date)
```
    Parses a Calendar object into a DATE1 string.
    
    Parameters:
    date - Calendar to parse
    
    Returns:
    parsed date or null if the calendar is null
    Since:
    
    6.4
  - getDate4
```
public static Calendar getDate4(String strDate)
```
    Parses a DATE4 string (accept dates in format YYYYMMDD) into a Calendar object.
    
    Parameters:
    strDate - string to parse
    
    Returns:
    parsed date or null if the argument did not matched the expected date format
  - getDateTime
```
public static String getDateTime(Calendar date)
```
    Parses a Calendar object into a string containing the DATETIME with YYYYMMDDHHMM format.
    
    Parameters:
    date - Calendar to parse
    
    Returns:
    parsed date or null if the calendar is null
    Since:
    
    7.4
  - getDateTime
```
public static Calendar getDateTime(String strDate)
```
    Parses a DATETIME string (accepts dates with time in YYYYMMDDHHMM format) into a Calendar object.
    
    Parameters:
    strDate - string to parse
    
    Returns:
    parsed date or null if the argument did not matched the expected date format
    Since:
    
    7.4
  - getDateTimeShortYear
```
public static String getDateTimeShortYear(Calendar date)
```
    Parses a Calendar object into a DATETIME with short year string in YYMMDDHHMM format.
    
    Parameters:
    date - Calendar to parse
    
    Returns:
    parsed date or null if the calendar is null
    Since:
    
    7.4
  - getDateTimeShortYear
```
public static Calendar getDateTimeShortYear(String strDate)
```
    Parses a DATETIME with short year string (accepts dates with time in YYMMDDHHMM format) into a Calendar object.
    
    Parameters:
    strDate - string to parse
    
    Returns:
    parsed date or null if the argument did not matched the expected date format
    Since:
    
    7.4
  - getDayTime
```
public static String getDayTime(Calendar date)
```
    Parses a Calendar object into a string containing the DAYTIME in DDHHMM format.
    
    Parameters:
    date - Calendar to parse
    
    Returns:
    parsed date or null if the calendar is null
    Since:
    
    7.4
  - getDayTime
```
public static Calendar getDayTime(String strDate)
```
    Parses a DAYTIME string (accepts dates with time in DDHHMM format) into a Calendar object.
    
    Parameters:
    strDate - string to parse
    
    Returns:
    parsed date or null if the argument did not matched the expected date format
    Since:
    
    7.4
  - getHhmm
```
public static Calendar getHhmm(String hhmm)
```
    Parameters:
    hhmm - hour and minutes
    
    Returns:
    a Calendar set with the given hour and minutes
  - getHour
```
public static String getHour(Calendar date)
```
    Parses a Calendar object into a string containing the HOUR in HH format.
    
    Parameters:
    date - Calendar to parse
    
    Returns:
    parsed date or null if the calendar is null
    Since:
    
    7.4
  - getHour
```
public static Calendar getHour(String strDate)
```
    Parses an HOUR string (accepts time in HH format) into a Calendar object.
    
    Parameters:
    strDate - string to parse
    
    Returns:
    parsed date or null if the argument did not matched the expected date format
    Since:
    
    7.4
  - getMIR
```
public static String getMIR(MIR mir)
```
    Parses a MIR object into a string containing its serialized data.
    
    Parameters:
    mir - MIR to process
    
    Returns:
    serialized content of the MIR object or null if the parameter is empty or null
    Since:
    
    7.4
    
    See Also:
    MIR.getMIR()
  - getMIR
```
public static MIR getMIR(String value)
```
    Parses a string value into a MIR object.
    
    Parameters:
    value - string containing the complete MIR value
    
    Returns:
    a MIR object containing the parsed data or null if the argument is not a 28 length string with a proper MIR data
    See Also:
    MIR
  - getMonthDay
```
public static String getMonthDay(Calendar date)
```
    Parses a Calendar object into a string containing MONTHDAY in MMDD format.
    
    Parameters:
    date - Calendar to parse
    
    Returns:
    parsed date or null if the calendar is null
    Since:
    
    7.4
  - getMonthDay
```
public static Calendar getMonthDay(String strDate)
```
    Parses a MONTHDAY string (accepts dates in MMDD format) into a Calendar object.
    
    Parameters:
    strDate - string to parse
    
    Returns:
    parsed date or null if the argument did not matched the expected date format
    Since:
    
    7.4
  - getMOR
```
public static String getMOR(MOR mor)
```
    Parses a MOR object into a string containing its serialized data.
    
    Parameters:
    mor - MOR to process
    
    Returns:
    serialized content of the MOR object or null if the parameter is empty or null
    Since:
    
    7.4
    
    See Also:
    MOR.getMOR()
  - getMOR
```
public static MOR getMOR(String value)
```
    Parses a string value into a MOR object.
    
    Parameters:
    value - string containing the complete MOR value
    
    Returns:
    a MOR object containing the parsed data or null if the argument is not a 28 length string with a proper MOR data
    See Also:
    MOR
  - getNumber
```
public static String getNumber(Number number)
```
    Parses a Number into a SWIFT string number ####,## where trunked zero decimals and mandatory decimal separator.
    - Example: 1234,
    - Example: 1234,56
    Parameters:
    number - to parse
    
    Returns:
    Number of the parsed amount or null if the number is null
  - getNumber
```
public static Number getNumber(String amount)
```
    Parses a value into a java Number (BigDecimal) using the comma for decimal separator.
    
    Parameters:
    amount - to parse
    
    Returns:
    Number of the parsed amount or null if the number could not be parsed
  - getOffset
```
public static String getOffset(Calendar date)
```
    Parses a Calendar object into a offset string.
    
    Parameters:
    date - Calendar to parse
    
    Returns:
    parsed time or null if the calendar is null
    Since:
    
    6.4
  - getOffset
```
public static Calendar getOffset(String string)
```
    Parameters:
    string - with an offset
    
    Returns:
    a Calendar set with hour and minutes from the offset
  - getSign
```
public static Character getSign(String string)
```
    Parameters:
    string - with a single character
    
    Returns:
    the Character for the given string
  - getTime2
```
public static String getTime2(Calendar date)
```
    Parses a Calendar object into a TIME2 string.
    
    Parameters:
    date - Calendar to parse
    
    Returns:
    parsed time or null if the calendar is null
    Since:
    
    6.4
  - getTime2
```
public static Calendar getTime2(String hhmmss)
```
    Parameters:
    hhmmss - hour, minutes and seconds
    
    Returns:
    a Calendar set with the given hour, minutes and seconds
  - getTime3
```
public static String getTime3(Calendar date)
```
    Parses a Calendar object into a TIME3 string.
    
    Parameters:
    date - Calendar to parse
    
    Returns:
    parsed time or null if the calendar is null
    Since:
    
    6.4
  - getTime3
```
public static Calendar getTime3(String hhmmss)
```
    Parameters:
    hhmmss - hour, minutes and seconds
    
    Returns:
    a Calendar set with the given hour, or and hour and minutes
  - getYear
```
public static String getYear(Calendar date)
```
    Parses a Calendar object into a YYYY string.
    
    Parameters:
    date - Calendar to parse
    
    Returns:
    parsed date or null if the calendar is null
    Since:
    
    6.4
  - getYear
```
public static Calendar getYear(String strDate)
```
    Parses a YEAR string (accept dates in format YYYY) into a Calendar object.
    
    Parameters:
    strDate - string to parse
    
    Returns:
    parsed date or null if the argument did not matched the expected date format
  - isCurrency
```
public static boolean isCurrency(String string)
```
    Tell if string is a valid currency code
    
    Parameters:
    string - the string to test for a currency code
    
    Returns:
    true if string is a valid currency code and false in other case, including null and empty

Class SwiftFormatUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SwiftFormatUtils

Method Detail

getBIC

getBIC

getBoolean

getBoolean

getCurrency

getCurrency

getDate1

getDate1

getDate2

getDate2

getDate3

getDate3

getDate4

getDate4

getDateTime

getDateTime

getDateTimeShortYear

getDateTimeShortYear

getDayTime

getDayTime

getHhmm

getHour

getHour

getMIR

getMIR

getMonthDay

getMonthDay

getMOR

getMOR

getNumber

getNumber

getOffset

getOffset

getSign

getTime2

getTime2

getTime3

getTime3

getYear

getYear

isCurrency