Package convex.core.data

Class Blobs

java.lang.Object

convex.core.data.Blobs

public class Blobs
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_ENCODING_LENGTH

Constructor Summary

Constructors

Constructor	Description
Blobs()

Method Summary

Modifier and Type	Method	Description
static ABlob	createFilled(int value, long length)	Create a Blob entirely filled with a given value
static <T extends ABlob> T	createRandom(long length)
static <T extends ABlob> T	createRandom(Random r, long length)
static ABlob	createZero(long length)	Create a Blob entirely filled with zeros
static Blob	empty()
static byte[]	ensureZeroBasedArray(AArrayBlob b)	Gets a zero-based array containing the contents of the given Blob.
static ABlob	fromHex(AString a)	Creates a blob from a hex string
static ABlob	fromHex(String a)	Creates a blob from a hex string
static ABlob	parse(Object o)	Best effort attempt to parse a Blob.
static ABlob	parse(String s)	Best effort attempt to parse a Blob.
static <T extends ABlob> T	read(Blob source, int pos)	Reads a canonical Blob from a Blob source
static ABlob	toCanonical(ABlob a)	Converts any blob to a correct canonical Blob format

Methods inherited from class java.lang.Object

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

Field Details

MAX_ENCODING_LENGTH

public static final int MAX_ENCODING_LENGTH

Constructor Details

Blobs

public Blobs()

Method Details

createRandom

public static <T extends ABlob> T createRandom(long length)

createRandom

public static <T extends ABlob> T createRandom(Random r,
 long length)

toCanonical

public static ABlob toCanonical(ABlob a)

Converts any blob to a correct canonical Blob format

Parameters:

a - Any Blob

Returns:

Canonical version s a Blob or BlobTree

fromHex

public static ABlob fromHex(String a)

Creates a blob from a hex string

Parameters:

a - Hex String

Returns:

Blob created, or null if String not valid hex

fromHex

public static ABlob fromHex(AString a)

Creates a blob from a hex string

Parameters:

a - Hex String

Returns:

Blob created, or null if String not valid hex

parse

public static ABlob parse(Object o)

Best effort attempt to parse a Blob. Must parse as a Blob of correct length

Parameters:

o - Object expected to contain a Blob value

Returns:

ABlob value, or null if not parseable

parse

public static ABlob parse(String s)

Best effort attempt to parse a Blob. Must parse as a Blob of correct length. Leading "0x" optional.

Parameters:

s - String expected to contain a single Blob value in hex

Returns:

ABlob value, or null if not parseable

read

public static <T extends ABlob> T read(Blob source,
 int pos)
                                throws BadFormatException

Reads a canonical Blob from a Blob source

Type Parameters:

T - Type of Blob result

Parameters:

source - Source blob, containing tag

pos - position to read from source, assumed to be tag

Returns:

Canonical Blob

Throws:

BadFormatException - if the Blob encoding format is invalid

createFilled

public static ABlob createFilled(int value,
 long length)

Create a Blob entirely filled with a given value

Parameters:

value - Byte value to fill with (low 8 bits used)

length - Length of Blob to create

Returns:

Blob filled with given value

createZero

public static ABlob createZero(long length)

Create a Blob entirely filled with zeros

Parameters:

length - Length of Blob to create

Returns:

Blob filled with zeros

empty

public static Blob empty()

ensureZeroBasedArray

public static byte[] ensureZeroBasedArray(AArrayBlob b)

Gets a zero-based array containing the contents of the given Blob. MAY use current internal array if possible. WARNING: may return underlying array, should never be mutated

Parameters:

b - Blob to get array for

Returns:

byte array containing the blob contents starting at offset zero