com.chemaxon.descriptors.common.binary

Class BinaryVectorDescriptorSerializer

java.lang.Object

com.chemaxon.descriptors.common.binary.BinaryVectorDescriptorSerializer

All Implemented Interfaces:

DescriptorSerializer<BinaryVectorDescriptor>, Guarded, Serializable

public final class BinaryVectorDescriptorSerializer
extends Object
implements DescriptorSerializer<BinaryVectorDescriptor>

Serializer for BinaryVectorDescriptor. The serialized representation is BinaryVectorDescriptorImpl.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.chemaxon.descriptors.common.Guarded

Guarded.EnsureThat, Guarded.New

Constructor Summary

Constructors

Constructor and Description
BinaryVectorDescriptorSerializer(Object guardObject, int size, BinaryVectors.Endianness endianness) Construct.

Method Summary

Modifier and Type	Method and Description
BinaryVectorDescriptor	fromByteArray(byte[] desc) Builds a descriptor from its byte array representation.
BinaryVectorDescriptor	fromString(String desc) Builds a descriptor from its string representation.
Object	getGuardObject() Gets the guard object associated to the generated descriptors/utilities.
boolean	serializerIsEqualWith(DescriptorSerializer other) Check strict equivalence of serializers.
byte[]	toByteArray(BinaryVectorDescriptor desc) Creates the byte array representation of a descriptor object.
String	toString(BinaryVectorDescriptor desc) Creates the String representation of a descriptor object.

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryVectorDescriptorSerializer

public BinaryVectorDescriptorSerializer(Object guardObject,
                                        int size,
                                        BinaryVectors.Endianness endianness)

Construct.

External API contracts: guarding must ensure that this instance is fed with BinaryVectorDescriptorImpl instances with matching size and BinaryVectors.Endianness parameter.

Parameters:

guardObject - Associated guard objects.

size - Associated size

endianness - Endianness parameter of underlying BinaryVectorDescriptorImpl constructors.

Method Detail

toByteArray

public byte[] toByteArray(BinaryVectorDescriptor desc)

Description copied from interface: DescriptorSerializer

Creates the byte array representation of a descriptor object. Note that implementations of this method must ensure the matching of associated guard objects.

The descriptors bare form can be reconstructed using DescriptorSerializer.fromByteArray(byte[]).

Specified by:

toByteArray in interface DescriptorSerializer<BinaryVectorDescriptor>

Parameters:

desc - Descriptor (only bare form is considered)

Returns:

Byte array representation of the descriptor

toString

public String toString(BinaryVectorDescriptor desc)

Description copied from interface: DescriptorSerializer

Creates the String representation of a descriptor object.

The descriptors bare form can be reconstructed using DescriptorSerializer.fromString(java.lang.String).

Specified by:

toString in interface DescriptorSerializer<BinaryVectorDescriptor>

Parameters:

desc - Descriptor (only bare form is considered)

Returns:

String representation of descriptor

fromString

public BinaryVectorDescriptor fromString(String desc)

Description copied from interface: DescriptorSerializer

Builds a descriptor from its string representation.

Please note that the compatibility of this (the reconstructing) DescriptorGenerator, regarding to the serializing generator (on which DescriptorSerializer.toString(com.chemaxon.descriptors.common.Descriptor) was called to construct the String form) is not checked; compatibility must be ensured by the user application.

Specified by:

fromString in interface DescriptorSerializer<BinaryVectorDescriptor>

Parameters:

desc - String representation

Returns:

Reconstructed descriptors bare form

fromByteArray

public BinaryVectorDescriptor fromByteArray(byte[] desc)

Description copied from interface: DescriptorSerializer

Builds a descriptor from its byte array representation.

Please note that the compatibility of this (the reconstructing) DescriptorGenerator, regarding to the serializing generator (on which DescriptorSerializer.toByteArray(com.chemaxon.descriptors.common.Descriptor) was called to construct the byte array form) is not checked; compatibility must be ensured by the user application.

Specified by:

fromByteArray in interface DescriptorSerializer<BinaryVectorDescriptor>

Parameters:

desc - Byte array of the descriptor

Returns:

Reconstructed descriptors bare form

getGuardObject

public Object getGuardObject()

Description copied from interface: Guarded

Gets the guard object associated to the generated descriptors/utilities. Note that serialization/deserialization must preserve guard object reference.

This method is intended to use only for ensuring the compatibility of manipulated objects.

Implementations might use the associated DescriptorGenerator or DescriptorParameters reference as the guard object, however it is a non recommended practice to use this method to access the associated generator to perform further operations on it.

Specified by:

getGuardObject in interface Guarded

Returns:

The guard object, can not be null.

serializerIsEqualWith

public boolean serializerIsEqualWith(DescriptorSerializer other)

Description copied from interface: DescriptorSerializer

Check strict equivalence of serializers. Implementations are expected to be symmetric and transitive.

Specified by:

serializerIsEqualWith in interface DescriptorSerializer<BinaryVectorDescriptor>

Parameters:

other - Other serializer

Returns:

true when and only when the two serializers (this and other) are the same thus interchangeable. Implementations typically check class equivalence, guard object match and parameter match.