net.snowflake.common.core

Enum SFBinaryFormat

java.lang.Object

java.lang.Enum<SFBinaryFormat>

net.snowflake.common.core.SFBinaryFormat

All Implemented Interfaces:

Serializable, Comparable<SFBinaryFormat>

public enum SFBinaryFormat
extends Enum<SFBinaryFormat>

Format (encoding scheme) for binary values. This corresponds to the BinaryFormat class in XP. There are three formats: 1. HEX (hexadecimal encoding) 2. BASE64 (RFC 4648 Base64 encoding) 3. UTF-8 or UTF8 Each kind does two things: 1. format - convert from SFBinary to String 2. parse - convert from String to SFBinary For HEX and BASE64, "format" means "encode", and "parse" (which can fail) means "decode". For UTF-8, it is the reverse: "format" means to decode bytes as Unicode characters (which can fail), and "parse" means to encode a string of as UTF-8 bytes (which always suceeds).

Author:

mkember

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASE64
HEX
UTF8

Field Summary

Fields

Modifier and Type	Field and Description
static SFBinaryFormat	DEFAULT The default binary format.

Method Summary

Modifier and Type	Method and Description
abstract String	format(SFBinary binary) Format a binary value as a string.
static SFBinaryFormat	getFormat(String name) Looks up a binary format by case-insensitive name.
static SFBinaryFormat	getSafeOutputFormat(String name) Looks up a binary format suitable for text output.
abstract SFBinary	parse(String string) Parse a binary value as a string.
static SFBinaryFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static SFBinaryFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HEX

public static final SFBinaryFormat HEX

BASE64

public static final SFBinaryFormat BASE64

UTF8

public static final SFBinaryFormat UTF8

Field Detail

DEFAULT

public static final SFBinaryFormat DEFAULT

The default binary format. NOTE: Keep this in sync with BinaryFormat::DEFAULT in XP.

Method Detail

values

public static SFBinaryFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SFBinaryFormat c : SFBinaryFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SFBinaryFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

format

public abstract String format(SFBinary binary)

Format a binary value as a string.

Parameters:

binary - SFBinary

Returns:

formatted binary value

Throws:

IllegalArgumentException - if the binary cannot be formatted.

parse

public abstract SFBinary parse(String string)

Parse a binary value as a string.

Parameters:

string - a string

Returns:

SFBinary instance

Throws:

IllegalArgumentException - if the string cannot be parsed.

getFormat

public static SFBinaryFormat getFormat(String name)

Looks up a binary format by case-insensitive name. HEX, BASE64 or UTF-8

Parameters:

name - binary format

Returns:

SFBinaryFormat instance

Throws:

IllegalArgumentException - if the name is invalid.

getSafeOutputFormat

public static SFBinaryFormat getSafeOutputFormat(String name)

Looks up a binary format suitable for text output. Specifically, does not allow UTF-8 because not all binary values can be formatted with the UTF-8 format.

Parameters:

name - binary format

Returns:

SFBinaryFormat instance

Throws:

IllegalArgumentException - if the name is invalid.