Class Blob (3.49.0)

3.49.0 (latest) 3.45.0 3.44.0 3.43.1 3.41.0 3.38.0 3.37.0 3.36.0 3.35.1 3.33.4 3.32.2 3.31.9 3.30.11 3.28.0 3.27.2 3.26.5 3.25.1 3.24.3 3.22.0 3.21.4 3.20.0 3.17.0 3.16.3 3.15.7 3.14.4 3.13.2 3.12.1 3.11.0 3.10.0 3.9.6 3.8.2 3.7.10 3.6.0 3.5.0 3.4.2 3.3.0 3.2.0 3.1.0 3.0.21

public final class Blob implements Serializable

Immutable class representing an array of bytes in Firestore.

Inheritance

Object > Blob

Implements

Serializable

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

createBsonBinary(byte[] bytes)

public static Blob createBsonBinary(byte[] bytes)

Creates a new Blob instance representing a BSON binary data type. Sets subtype to 0 and representation to BSON.

Parameter
Name	Description
bytes	byte[] The bytes to use for this Blob instance.

Returns
Type	Description
Blob	The new Blob instance

createBsonBinary(ByteString data)

public static Blob createBsonBinary(ByteString data)

Creates a new Blob instance representing a BSON binary data type. Sets subtype to 0 and representation to BSON.

Parameter
Name	Description
data	ByteString The ByteString to use for this Blob instance.

Returns
Type	Description
Blob	The new Blob instance

createBsonBinary(int subtype, byte[] bytes)

public static Blob createBsonBinary(int subtype, byte[] bytes)

Creates a new Blob instance representing a BSON binary data type with a specific subtype. Sets representation to BSON.

Parameters
Name	Description
subtype	int The subtype to use for this instance.
bytes	byte[] The bytes to use for this Blob instance.

Returns
Type	Description
Blob	The new Blob instance

createBsonBinary(int subtype, ByteString data)

public static Blob createBsonBinary(int subtype, ByteString data)

Creates a new Blob instance representing a BSON binary data type with a specific subtype. Sets representation to BSON.

Parameters
Name	Description
subtype	int The subtype to use for this instance.
data	ByteString The ByteString to use for this Blob instance.

Returns
Type	Description
Blob	The new Blob instance

fromByteString(ByteString byteString)

public static Blob fromByteString(ByteString byteString)

Creates a new Blob instance from the provided ByteString. Defaults to subtype 0 and native representation.

Parameter
Name	Description
byteString	ByteString The byteString to use for this Blob instance.

Returns
Type	Description
Blob	The new Blob instance

fromBytes(byte[] bytes)

public static Blob fromBytes(byte[] bytes)

Creates a new Blob instance from the provided bytes. Makes a copy of the bytes passed in. Defaults to subtype 0 and native representation.

Parameter
Name	Description
bytes	byte[] The bytes to use for this Blob instance.

Returns
Type	Description
Blob	The new Blob instance

Methods

equals(Object obj)

public boolean equals(Object obj)

Returns true if this Blob is equal to the provided object.

Parameter
Name	Description
obj	Object The object to compare against.

Returns
Type	Description
boolean	Whether this Blob is equal to the provided object.

Overrides

Object.equals(Object)

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

Object.hashCode()

subtype()

public int subtype()

Returns the subtype of this binary data. Defaults to 0 for both native binary and BSON binary if not specified.

Returns
Type	Description
int	The subtype of the binary data.

toByteString()

public ByteString toByteString()

Returns the backing data as a ByteString.

Returns
Type	Description
ByteString	The bytes of this blob as a byteString

toBytes()

public byte[] toBytes()

Returns a copy of the underlying bytes as a byte[] array.

Returns
Type	Description
byte[]	The bytes of this blob as a byte[] array.

toString()

public String toString()

Returns
Type	Description
String

Overrides

Object.toString()