com.allanbank.mongodb.bson.element

Class BinaryElement

java.lang.Object

com.allanbank.mongodb.bson.element.AbstractElement

com.allanbank.mongodb.bson.element.BinaryElement

All Implemented Interfaces:

Element, ElementAssignable, Serializable, Comparable<Element>

Direct Known Subclasses:

UuidElement

public class BinaryElement
extends AbstractElement

A wrapper for a BSON binary.

See Also:

Serialized Form

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2011-2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static byte	DEFAULT_SUB_TYPE The sub type used when no sub type is specified.
static ElementType	TYPE The BSON type for a binary.

Fields inherited from class com.allanbank.mongodb.bson.element.AbstractElement

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
BinaryElement(String name, byte[] value) Constructs a new BinaryElement.
BinaryElement(String name, byte subType, BsonInputStream input, int length) Constructs a new BinaryElement.
BinaryElement(String name, byte subType, BsonInputStream input, int length, long size) Constructs a new BinaryElement.
BinaryElement(String name, byte subType, byte[] value) Constructs a new BinaryElement.
BinaryElement(String name, byte subType, byte[] value, long size) Constructs a new BinaryElement.

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Accepts the visitor and calls the Visitor.visitBinary(java.lang.String, byte, byte[]) method.
int	compareTo(Element otherElement)
boolean	equals(Object object) Determines if the passed object is of this same type as this object and if so that its fields are equal.
byte	get(int offset) Returns the byte value at the specified offset.
byte	getSubType() Return the binary sub-type.
ElementType	getType() Returns the type for the BSON type.
byte[]	getValue() Returns the BSON binary value.
Object	getValueAsObject() Returns the value for BSON element as a Java Object type.
int	hashCode() Computes a reasonable hash code.
int	length() Returns the length of the contained byte array.
BinaryElement	withName(String name) Creates a new element with the same type and value as this element but with the specified name.

Methods inherited from class com.allanbank.mongodb.bson.element.AbstractElement

asElement, find, find, findFirst, findFirst, getName, getValueAsString, nullSafeEquals, size, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SUB_TYPE

public static final byte DEFAULT_SUB_TYPE

The sub type used when no sub type is specified.

See Also:

Constant Field Values

TYPE

public static final ElementType TYPE

The BSON type for a binary.

Constructor Detail

BinaryElement

public BinaryElement(String name,
             byte subType,
             BsonInputStream input,
             int length)
              throws IOException

Constructs a new BinaryElement.

Parameters:

name - The name for the BSON binary.

subType - The sub-type of the binary data.

input - The stream to read the data from.

length - The number of bytes of data to read.

Throws:

IllegalArgumentException - If the name is null.

IOException - If there is an error reading from input stream.

BinaryElement

public BinaryElement(String name,
             byte subType,
             BsonInputStream input,
             int length,
             long size)
              throws IOException

Constructs a new BinaryElement.

Parameters:

name - The name for the BSON binary.

subType - The sub-type of the binary data.

input - The stream to read the data from.

length - The number of bytes of data to read.

size - The size of the element when encoded in bytes. If not known then use the BinaryElement(String, byte, BsonInputStream, int) constructor instead.

Throws:

IllegalArgumentException - If the name is null.

IOException - If there is an error reading from input stream.

BinaryElement

public BinaryElement(String name,
             byte subType,
             byte[] value)

Constructs a new BinaryElement.

Parameters:

name - The name for the BSON binary.

subType - The sub-type of the binary data.

value - The BSON binary value.

Throws:

IllegalArgumentException - If the name or value is null.

BinaryElement

public BinaryElement(String name,
             byte subType,
             byte[] value,
             long size)

Constructs a new BinaryElement.

Parameters:

name - The name for the BSON binary.

subType - The sub-type of the binary data.

value - The BSON binary value.

size - The size of the element when encoded in bytes. If not known then use the BinaryElement(String, byte, byte[]) constructor instead.

Throws:

IllegalArgumentException - If the name or value is null.

BinaryElement

public BinaryElement(String name,
             byte[] value)

Constructs a new BinaryElement. Uses the DEFAULT_SUB_TYPE.

Parameters:

name - The name for the BSON binary.

value - The BSON binary value.

Throws:

IllegalArgumentException - If the name or value is null.

Method Detail

accept

public void accept(Visitor visitor)

Accepts the visitor and calls the Visitor.visitBinary(java.lang.String, byte, byte[]) method.

Parameters:

visitor - The visitor for the element.

See Also:

Element.accept(Visitor)

compareTo

public int compareTo(Element otherElement)

Overridden to compare the elements based on the tuple (name, type, value).

Overridden to compare the elements based on the tuple (name, type). Derived classes are responsible for the value portion of the full comparison.

Overridden to compare the sub-types and bytes if the base class comparison is equals.

Specified by:

compareTo in interface Element

Specified by:

compareTo in interface Comparable<Element>

Overrides:

compareTo in class AbstractElement

equals

public boolean equals(Object object)

Determines if the passed object is of this same type as this object and if so that its fields are equal.

Overrides:

equals in class AbstractElement

Parameters:

object - The object to compare to.

See Also:

Object.equals(java.lang.Object)

get

public final byte get(int offset)

Returns the byte value at the specified offset.

Parameters:

offset - The offset of the desired value.

Returns:

The byte value at the offset.

Throws:

ArrayIndexOutOfBoundsException - If the offset is not in the range [0, length()).

getSubType

public byte getSubType()

Return the binary sub-type.

Returns:

The binary sub-type.

getType

public ElementType getType()

Returns the type for the BSON type.

Returns:

The type for the BSON type.

getValue

public byte[] getValue()

Returns the BSON binary value. For safety reasons this method clones the internal byte array. To avoid the copying of the bytes use the length() and get(int) methods to access each byte value.

Returns:

The BSON binary value.

getValueAsObject

public Object getValueAsObject()

Returns the value for BSON element as a Java Object type.

Automatic conversion from the Object-ified value to an element is provided via the DocumentBuilder.add(String, Object) method. Not all element types will be successfully converted to the same element duing a Element-->Object value-->Element conversion. This cases are noted in the appropriate sub-type's JavaDoc.

Sub-types will also overload this method with the appropriate type returned. e.g., The StringElement.getValueAsObject() method signature returns a String.

Returns a byte[].

Note: This value will not be recreated is a Object-->Element conversion. The sub type is lost in this conversion to an Object.

Implementation Note: The return type cannot be a byte[] here as UuidElement returns a UUID.

Returns:

The value for BSON element as a Java Object type.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class AbstractElement

Returns:

The hash code value.

length

public final int length()

Returns the length of the contained byte array.

Returns:

The length of the contained byte array.

withName

public BinaryElement withName(String name)

Creates a new element with the same type and value as this element but with the specified name. This is useful when creating a query across a set of collections where the filed name changes in the collections but the values must be identical.

Returns a new BinaryElement.

Parameters:

name - The new name for the element.

Returns:

The created element.