org.apache.flink.table.utils

Class EncodingUtils

java.lang.Object

org.apache.flink.table.utils.EncodingUtils

@Internal
public abstract class EncodingUtils
extends Object

General utilities for string-encoding. This class is used to avoid additional dependencies to other projects.

Method Summary

Modifier and Type	Method and Description
static byte[]	decodeBase64ToBytes(String base64)
static String	decodeBase64ToString(String base64)
static byte[]	decodeHex(String str) Converts an array of characters representing hexadecimal values into an array of bytes of those same values.
static <T extends Serializable> T	decodeStringToObject(String base64String, Class<T> baseClass)
static <T extends Serializable> T	decodeStringToObject(String base64String, Class<T> baseClass, ClassLoader classLoader)
static <T> T	decodeStringToObject(String encodedStr, ClassLoader classLoader)
static String	encodeBytesToBase64(byte[] bytes)
static String	encodeObjectToString(Object serializable)
static String	encodeObjectToString(Serializable obj)
static String	encodeStringToBase64(String string)
static String	escapeBackticks(String s)
static String	escapeIdentifier(String s)
static String	escapeJava(String str) Escapes the characters in a String using Java String rules.
static String	escapeSingleQuotes(String s)
static String	hex(byte[] bytes)
static String	hex(String string)
static Class<?>	loadClass(String qualifiedName) Deprecated. Use loadClass(String, ClassLoader) instead, in order to explicitly provide the correct classloader.
static Class<?>	loadClass(String qualifiedName, ClassLoader classLoader)
static byte[]	md5(String string)
static String	repeat(char ch, int repeat) Returns padding using the specified delimiter repeated to a given length.
static String	repeat(String str, int repeat) Repeat a String repeat times to form a new String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

escapeBackticks

public static String escapeBackticks(String s)

escapeSingleQuotes

public static String escapeSingleQuotes(String s)

escapeIdentifier

public static String escapeIdentifier(String s)

encodeObjectToString

public static String encodeObjectToString(Object serializable)

encodeObjectToString

public static String encodeObjectToString(Serializable obj)

decodeStringToObject

public static <T> T decodeStringToObject(String encodedStr,
                                         ClassLoader classLoader)
                                  throws IOException

Throws:

IOException

decodeStringToObject

public static <T extends Serializable> T decodeStringToObject(String base64String,
                                                              Class<T> baseClass)

decodeStringToObject

public static <T extends Serializable> T decodeStringToObject(String base64String,
                                                              Class<T> baseClass,
                                                              ClassLoader classLoader)

loadClass

public static Class<?> loadClass(String qualifiedName,
                                 ClassLoader classLoader)

loadClass

@Deprecated
public static Class<?> loadClass(String qualifiedName)

Deprecated. Use loadClass(String, ClassLoader) instead, in order to explicitly provide the correct classloader.

encodeBytesToBase64

public static String encodeBytesToBase64(byte[] bytes)

decodeBase64ToBytes

public static byte[] decodeBase64ToBytes(String base64)

encodeStringToBase64

public static String encodeStringToBase64(String string)

decodeBase64ToString

public static String decodeBase64ToString(String base64)

md5

public static byte[] md5(String string)

hex

public static String hex(String string)

hex

public static String hex(byte[] bytes)

decodeHex

public static byte[] decodeHex(String str)
                        throws TableException

Converts an array of characters representing hexadecimal values into an array of bytes of those same values. The returned array will be half the length of the passed array, as it takes two characters to represent any given byte. An exception is thrown if the passed char array has an odd number of elements.

Copied from https://github.com/apache/commons-codec/blob/master/src/main/java/org/apache/commons/codec/binary/Hex.java.

Parameters:

str - An array of characters containing hexadecimal digits

Returns:

A byte array to contain the binary data decoded from the supplied char array.

Throws:

TableException - Thrown if an odd number of characters or illegal characters are supplied

repeat

public static String repeat(String str,
                            int repeat)

Repeat a String repeat times to form a new String.

 StringUtils.repeat(null, 2) = null
 StringUtils.repeat("", 0)   = ""
 StringUtils.repeat("", 2)   = ""
 StringUtils.repeat("a", 3)  = "aaa"
 StringUtils.repeat("ab", 2) = "abab"
 StringUtils.repeat("a", -2) = ""
 

Parameters:

str - the String to repeat, may be null

repeat - number of times to repeat str, negative treated as zero

Returns:

a new String consisting of the original String repeated, null if null String input

repeat

public static String repeat(char ch,
                            int repeat)

Returns padding using the specified delimiter repeated to a given length.

 StringUtils.repeat('e', 0)  = ""
 StringUtils.repeat('e', 3)  = "eee"
 StringUtils.repeat('e', -2) = ""
 

Note: this method doesn't not support padding with Unicode Supplementary Characters as they require a pair of chars to be represented. If you are needing to support full I18N of your applications consider using repeat(String, int) instead.

Parameters:

ch - character to repeat

repeat - number of times to repeat char, negative treated as zero

Returns:

String with repeated character

See Also:

repeat(String, int)

escapeJava

public static String escapeJava(String str)

Escapes the characters in a String using Java String rules.

Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.)

So a tab becomes the characters '\\' and 't'.

The only difference between Java strings and JavaScript strings is that in JavaScript, a single quote must be escaped.

Example:

 input string: He didn't say, "Stop!"
 output string: He didn't say, \"Stop!\"
 

Parameters:

str - String to escape values in, may be null

Returns:

String with escaped values, null if null string input