Package org.apache.cassandra.db.marshal

Class BytesType

java.lang.Object

org.apache.cassandra.db.marshal.AbstractType<ByteBuffer>

org.apache.cassandra.db.marshal.BytesType

All Implemented Interfaces:

Comparator<ByteBuffer>, AssignmentTestable

public class BytesType
extends AbstractType<ByteBuffer>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.cassandra.db.marshal.AbstractType

AbstractType.ComparisonType, AbstractType.DefaultArgumentDeserializer

Nested classes/interfaces inherited from interface org.apache.cassandra.cql3.AssignmentTestable

AssignmentTestable.TestResult

Field Summary

Fields

Modifier and Type	Field	Description
static final BytesType	instance

Fields inherited from class org.apache.cassandra.db.marshal.AbstractType

comparatorSet, comparisonType, isByteOrderComparable, reverseComparator

Method Summary

Modifier and Type	Method	Description
boolean	allowsEmpty()	Defines if the type allows an empty set of bytes (new byte[0]) as valid input.
CQL3Type	asCQL3Type()
Term	fromJSONObject(Object parsed)	Given a parsed JSON string, return a byte representation of the object.
ByteBuffer	fromString(String source)	get a byte representation of the given string.
ArgumentDeserializer	getArgumentDeserializer()
ByteBuffer	getMaskedValue()
TypeSerializer<ByteBuffer>	getSerializer()
boolean	isCompatibleWith(AbstractType<?> previous)	Returns true if this comparator is compatible with the provided previous comparator, that is if previous can safely be replaced by this.
boolean	isSerializationCompatibleWith(AbstractType<?> previous)	Similar to AbstractType.isValueCompatibleWith(AbstractType), but takes into account Cell encoding.
boolean	isValueCompatibleWithInternal(AbstractType<?> otherType)	Needed to handle ReversedType in value-compatibility checks.
String	toJSONString(ByteBuffer buffer, ProtocolVersion protocolVersion)	Converts the specified value into its JSON representation.

Methods inherited from class org.apache.cassandra.db.marshal.AbstractType

asComparableBytes, asComparableBytes, asCQLTypeStringList, checkComparable, compare, compare, compareCollectionMembers, compareCustom, compareForCQL, compose, compose, decompose, decomposeUntyped, expandUserTypes, freeze, freezeNestedMulticellTypes, fromComparableBytes, fromComparableBytes, getCompatibleTypeIfKnown, getComponents, getString, getString, getString, isCollection, isCounter, isEmptyValueMeaningless, isFreezable, isFrozenCollection, isMultiCell, isNull, isNull, isReversed, isTuple, isUDT, isValueCompatibleWith, isValueLengthFixed, isVector, parseDefaultParameters, read, readArray, readBuffer, readBuffer, referencesDuration, referencesUserType, referencesUserType, skipValue, subTypes, testAssignment, testAssignment, toCQLString, toJSONString, toString, toString, udfType, unfreeze, unwrap, validate, validate, validateCellValue, validateCollectionMember, valueLengthIfFixed, withUpdatedUserType, writeValue, writeValue, writtenLength, writtenLength

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Details

instance

public static final BytesType instance

Method Details

allowsEmpty

public boolean allowsEmpty()

Description copied from class: AbstractType

Defines if the type allows an empty set of bytes (new byte[0]) as valid input. The AbstractType.validate(Object, ValueAccessor) and AbstractType.compose(Object, ValueAccessor) methods must allow empty bytes when this returns true, and must reject empty bytes when this is false.

As of this writing, the main user of this API is for testing to know what types allow empty values and what types don't, so that the data that gets generated understands when ByteBufferUtil.EMPTY_BYTE_BUFFER is allowed as valid data.

Overrides:

allowsEmpty in class AbstractType<ByteBuffer>

fromString

public ByteBuffer fromString(String source)

Description copied from class: AbstractType

get a byte representation of the given string.

Specified by:

fromString in class AbstractType<ByteBuffer>

fromJSONObject

public Term fromJSONObject(Object parsed)
                    throws MarshalException

Description copied from class: AbstractType

Given a parsed JSON string, return a byte representation of the object.

Specified by:

fromJSONObject in class AbstractType<ByteBuffer>

Parameters:

parsed - the result of parsing a json string

Throws:

MarshalException

toJSONString

public String toJSONString(ByteBuffer buffer,
 ProtocolVersion protocolVersion)

Description copied from class: AbstractType

Converts the specified value into its JSON representation.

The buffer position will stay the same.

Overrides:

toJSONString in class AbstractType<ByteBuffer>

Parameters:

buffer - the value to convert

protocolVersion - the protocol version to use for the conversion

Returns:

a JSON string representing the specified value

isCompatibleWith

public boolean isCompatibleWith(AbstractType<?> previous)

Description copied from class: AbstractType

Returns true if this comparator is compatible with the provided previous comparator, that is if previous can safely be replaced by this. A comparator cn should be compatible with a previous one cp if forall columns c1 and c2, if cn.validate(c1) and cn.validate(c2) and cn.compare(c1, c2) == v, then cp.validate(c1) and cp.validate(c2) and cp.compare(c1, c2) == v. Note that a type should be compatible with at least itself and when in doubt, keep the default behavior of not being compatible with any other comparator!

Overrides:

isCompatibleWith in class AbstractType<ByteBuffer>

isValueCompatibleWithInternal

public boolean isValueCompatibleWithInternal(AbstractType<?> otherType)

Description copied from class: AbstractType

Needed to handle ReversedType in value-compatibility checks. Subclasses should implement this instead of isValueCompatibleWith().

Overrides:

isValueCompatibleWithInternal in class AbstractType<ByteBuffer>

isSerializationCompatibleWith

public boolean isSerializationCompatibleWith(AbstractType<?> previous)

Description copied from class: AbstractType

Similar to AbstractType.isValueCompatibleWith(AbstractType), but takes into account Cell encoding. In particular, this method doesn't consider two types serialization compatible if one of them has fixed length (overrides AbstractType.valueLengthIfFixed(), and the other one doesn't.

Overrides:

isSerializationCompatibleWith in class AbstractType<ByteBuffer>

asCQL3Type

public CQL3Type asCQL3Type()

Overrides:

asCQL3Type in class AbstractType<ByteBuffer>

getSerializer

public TypeSerializer<ByteBuffer> getSerializer()

Specified by:

getSerializer in class AbstractType<ByteBuffer>

getArgumentDeserializer

public ArgumentDeserializer getArgumentDeserializer()

Overrides:

getArgumentDeserializer in class AbstractType<ByteBuffer>

Returns:

the deserializer used to deserialize the function arguments of this type.

getMaskedValue

public ByteBuffer getMaskedValue()

Overrides:

getMaskedValue in class AbstractType<ByteBuffer>

Returns:

A fixed, serialized value to be used when the column is masked, to be returned instead of the real value.