StringConverters (Root POM 0.9.18-SNAPSHOT API)

java.lang.Object
- de.larssh.utils.text.StringConverters

```
public final class StringConverters
extends Object
```
This class contains helper methods for decoding and encoding strings.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`decodeBase64(String value)` Decodes `value` as Base64 string.
`static String`	`decodeBase64Mime(String value)` Decodes `value` using the Base64 MIME type decoding scheme.
`static String`	`decodeBase64Url(String value)` Decodes `value` as Base64 URL and filename-safe string.
`static Csv`	`decodeCsv(String data, char separator, char escaper)` Parses the CSV data given by `data`.
`static String`	`decodeUrl(String value)` Decodes an `application/x-www-form-urlencoded` string.
`static String`	`encodeBase64(String value)` Translates `value` into Base64 format.
`static String`	`encodeBase64Mime(String value)` Translates `value` into Base64 MIME type encoding scheme.
`static String`	`encodeBase64Url(String value)` Translates `value` into Base64 URL and filename-safe format.
`static String`	`encodeCsv(Collection<? extends Collection<String>> data, char separator, char escaper)` Encodes `data` as CSV document.
`static String`	`encodeCsvRow(Collection<? extends String> values, char separator, char escaper)` Encodes `values` as one CSV row.
`static String`	`encodeCsvValue(String value, char separator, char escaper)` Encodes `value` into a single CSV value.
`static String`	`encodeUrl(String value)` Translates a string into `application/x-www-form-urlencoded` format with the char set `StandardCharsets.UTF_8` as the World Wide Web Consortium Recommendation states that UTF-8 should be used.

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

- Method Detail
  - decodeBase64
```
public static String decodeBase64(String value)
```
    Decodes value as Base64 string.
    This method is equivalent to using Base64.getDecoder() with the char set Strings.DEFAULT_CHARSET.
    
    Parameters:
    
    value - the value to be decoded
    
    Returns:
    
    the decoded value
  - decodeBase64Mime
```
public static String decodeBase64Mime(String value)
```
    Decodes value using the Base64 MIME type decoding scheme.
    This method is equivalent to using Base64.getMimeDecoder() with the char set Strings.DEFAULT_CHARSET.
    
    Parameters:
    
    value - the value to be decoded
    
    Returns:
    
    the decoded value
  - decodeBase64Url
```
public static String decodeBase64Url(String value)
```
    Decodes value as Base64 URL and filename-safe string.
    This method is equivalent to using Base64.getUrlDecoder() with the char set Strings.DEFAULT_CHARSET.
    
    Parameters:
    
    value - the value to be decoded
    
    Returns:
    
    the decoded value
  - decodeCsv
```
public static Csv decodeCsv(String data,
                            char separator,
                            char escaper)
```
    Parses the CSV data given by data.
    To process Reader input, refer to Csv.parse(Reader, char, char).
    
    Parameters:
    
    data - the CSV input data
    
    separator - the CSV separator character
    
    escaper - the CSV escaping character
    
    Returns:
    
    an object representing the parsed CSV data
    
    Throws:
    
    IllegalArgumentException - on illegal separator or escaper value
  - decodeUrl
```
public static String decodeUrl(String value)
                        throws StringParseException
```
    Decodes an application/x-www-form-urlencoded string.
    This method is equivalent to using URLDecoder.decode(String) with the char set StandardCharsets.UTF_8 as the World Wide Web Consortium Recommendation states that UTF-8 should be used.
    
    Parameters:
    
    value - the value to be decoded
    
    Returns:
    
    the decoded value
    
    Throws:
    
    StringParseException - on illegal or incomplete hex characters
  - encodeBase64
```
public static String encodeBase64(String value)
```
    Translates value into Base64 format.
    This method is equivalent to using Base64.getEncoder() with the char set Strings.DEFAULT_CHARSET.
    
    Parameters:
    
    value - the value to be encoded
    
    Returns:
    
    the encoded value
  - encodeBase64Mime
```
public static String encodeBase64Mime(String value)
```
    Translates value into Base64 MIME type encoding scheme.
    This method is equivalent to using Base64.getMimeEncoder() with the char set Strings.DEFAULT_CHARSET.
    
    Parameters:
    
    value - the value to be encoded
    
    Returns:
    
    the encoded value
  - encodeBase64Url
```
public static String encodeBase64Url(String value)
```
    Translates value into Base64 URL and filename-safe format.
    This method is equivalent to using Base64.getUrlEncoder() with the charset Strings.DEFAULT_CHARSET.
    
    Parameters:
    
    value - the value to be encoded
    
    Returns:
    
    the encoded value
  - encodeCsv
```
public static String encodeCsv(Collection<? extends Collection<String>> data,
                               char separator,
                               char escaper)
```
    Encodes data as CSV document. Occurrences of special characters are encoded using escaper and values are separated using separator.
    For more information on single value escaping see encodeCsvValue(String, char, char).
    
    Parameters:
    
    data - the data to be encoded
    
    separator - the CSV separator character
    
    escaper - the CSV escaping character
    
    Returns:
    
    the encoded CSV document
  - encodeCsvRow
```
public static String encodeCsvRow(Collection<? extends String> values,
                                  char separator,
                                  char escaper)
```
    Encodes values as one CSV row. Occurrences of special characters are encoded using escaper and values are separated using separator.
    For more information on single value escaping see encodeCsvValue(String, char, char).
    
    Parameters:
    
    values - the values to be encoded
    
    separator - the CSV separator character
    
    escaper - the CSV escaping character
    
    Returns:
    
    the encoded CSV row
  - encodeCsvValue
```
public static String encodeCsvValue(String value,
                                    char separator,
                                    char escaper)
```
    Encodes value into a single CSV value. All occurrences of escaper are escaped (doubled). If value contains inappropriate characters, it is surrounded by escaper.
    Inappropriate characters are '\r', '\n', escaper and separator. The latter is used for the list of inappropriate characters only.
    Examples:
    Examples
    Parameter Return Value
    
    EMPTY EMPTY
    
    abc abc
    
    abc"xyz "abc""xyz"
    
    " """"
    
    Parameters:
    
    value - the value to be encoded
    
    separator - the CSV separator character
    
    escaper - the CSV escaping character
    
    Returns:
    
    the encoded value
  - encodeUrl
```
public static String encodeUrl(String value)
```
    Translates a string into application/x-www-form-urlencoded format with the char set StandardCharsets.UTF_8 as the World Wide Web Consortium Recommendation states that UTF-8 should be used.
    
    Parameters:
    
    value - the value to be encoded
    
    Returns:
    
    the encoded value

Examples
Parameter	Return Value
EMPTY	EMPTY
abc	abc
abc"xyz	"abc""xyz"
"	""""

Class StringConverters

Method Summary

Methods inherited from class java.lang.Object

Method Detail

decodeBase64

decodeBase64Mime

decodeBase64Url

decodeCsv

decodeUrl

encodeBase64

encodeBase64Mime

encodeBase64Url

encodeCsv

encodeCsvRow

encodeCsvValue

encodeUrl