SFBinary (GSCommon 4.0.1 API)

java.lang.Object
- net.snowflake.common.core.SFBinary

```
public class SFBinary
extends Object
```
Represents binary values. Just a wrapper around a byte array. Instances of this class are immutable.

Author:

mkember

Field Summary

Fields
Modifier and Type Field and Description

static SFBinary EMPTY
An empty SFBinary.

static SFBinary MAXIMUM
Special SFBinary that is greater than all others.

Fields
Modifier and Type	Field and Description
`static SFBinary`	`EMPTY` An empty SFBinary.
`static SFBinary`	`MAXIMUM` Special SFBinary that is greater than all others.

Constructor Summary

Constructors
Constructor and Description

SFBinary(byte[] bytes)
Constructs an SFBinary from a byte array.

Constructors
Constructor and Description
`SFBinary(byte[] bytes)` Constructs an SFBinary from a byte array.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(SFBinary other)` Compares SFBinary
`SFBinary`	`concat(SFBinary other)` Concatenates two binary values.
`boolean`	`equals(Object other)`
`static SFBinary`	`fromBase64(String str)` Creates an SFBinary by decoding a Base64-encoded string (RFC 4648).
`static SFBinary`	`fromHex(String str)` Creates an SFBinary by decoding a hex-encoded string (uppercase letters).
`byte[]`	`getBytes()` Returns the underlying byte array.
`int`	`hashCode()`
`int`	`length()` Returns the length of the SFBinary in bytes.
`SFBinary`	`substring(int start, int end)` Returns a new SFBinary that is a substring of this SFBinary.
`String`	`toBase64()` Encodes the binary value as a Base64 string (RFC 4648).
`String`	`toHex()` Encodes the binary value as a hex string (uppercase letters).
`String`	`toString()`
`static boolean`	`validHex(String str)` Returns true if it's safe to call SFBinary.fromHex(str).

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

- Field Detail
  - EMPTY
```
public static final SFBinary EMPTY
```
    An empty SFBinary.
  - MAXIMUM
```
public static final SFBinary MAXIMUM
```
    Special SFBinary that is greater than all others. Specifically, MAXIMUM.compareTo(x) > 0 for all x != MAXIMUM. This value has no byte array representation, so calling getBytes, toBase64, or concat on it is NOT allowed. It does, however, have a special representation "Z", so SFBinary.fromHex("Z") returns MAXIMUM, and MAXIMUM.toHex() returns "Z".
- Constructor Detail
  - SFBinary
```
public SFBinary(byte[] bytes)
```
    Constructs an SFBinary from a byte array.
    
    Parameters:
    
    bytes - an byte array
- Method Detail
  - validHex
```
public static boolean validHex(String str)
```
    Returns true if it's safe to call SFBinary.fromHex(str). This is meant for checking user input, so it allows spaces, newlines, and carriage returns. It returns false for the special value "Z".
    
    Parameters:
    
    str - a string
    
    Returns:
    
    true if a string is a hexadecimal value otherwise false
  - fromHex
```
public static SFBinary fromHex(String str)
```
    Creates an SFBinary by decoding a hex-encoded string (uppercase letters). Handles the special value "Z" by returning MAXIMUM.
    
    Parameters:
    
    str - a string
    
    Returns:
    
    SFBinary
    
    Throws:
    
    IllegalArgumentException - if the string is not hex-encoded.
  - fromBase64
```
public static SFBinary fromBase64(String str)
```
    Creates an SFBinary by decoding a Base64-encoded string (RFC 4648).
    
    Parameters:
    
    str - a string.
    
    Returns:
    
    SFBinary
    
    Throws:
    
    IllegalArgumentException - if the string is not Base64-encoded.
  - getBytes
```
public byte[] getBytes()
```
    Returns the underlying byte array.
    
    Returns:
    
    a byte array
  - length
```
public int length()
```
    Returns the length of the SFBinary in bytes.
    
    Returns:
    
    byte length
  - toHex
```
public String toHex()
```
    Encodes the binary value as a hex string (uppercase letters). Handles MAXIMUM by returning the special value "Z".
    
    Returns:
    
    a hexdecimal string
  - toBase64
```
public String toBase64()
```
    Encodes the binary value as a Base64 string (RFC 4648).
    
    Returns:
    
    a base64 string
  - substring
```
public SFBinary substring(int start,
                          int end)
```
    Returns a new SFBinary that is a substring of this SFBinary. Same semantics as String.substring: 'start' is inclusive, 'end' is exclusive, and 'start' cannot be greater than 'end'.
    
    Parameters:
    
    start - the starting index of byte array
    
    end - the ending index of byte array
    
    Returns:
    
    SFBinary
  - concat
```
public SFBinary concat(SFBinary other)
```
    Concatenates two binary values. Concatenates the bytes of this SFBinary with the bytes of the other SFBinary, returning a new SFBinary instance.
    
    Parameters:
    
    other - SFBinary to append
    
    Returns:
    
    concatenated SFBinary
  - compareTo
```
public int compareTo(SFBinary other)
```
    Compares SFBinary
    
    Parameters:
    
    other - the target SFBinary
    
    Returns:
    
    1 if this SFBinary is larger, 0 if identical otherwise -1
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SFBinary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

MAXIMUM

Constructor Detail

SFBinary

Method Detail

validHex

fromHex

fromBase64

getBytes

length

toHex

toBase64

substring

concat

compareTo

hashCode

equals

toString