org.cryptimeleon.math.hash.annotations

Class AnnotatedUbrUtil

java.lang.Object

org.cryptimeleon.math.hash.annotations.AnnotatedUbrUtil

public class AnnotatedUbrUtil
extends java.lang.Object

Utility class that allows for almost fully automated byte accumulation of member variables annotated with @UniqueByteRepresented.

Specifically, the updateAccumulator() method only has to be implemented as

 return AnnotatedUbrUtil.autoAccumulate(accumulator, this);
 

This will append the annotated object members (including those of superclasses) to the accumulator.

It is guaranteed that for objects i1 and i2, if !i1.x.equals(i2.x) (for some annotated object member x), then the data appended by AnnotatedUbrUtil.autoAccumulate(acc, i1) is different from AnnotatedUbrUtil.autoAccumulate(acc, i1). This depends on correct implementation of the UniqueByteRepresentable interface of used classes. Furthermore, the contract of UniqueByteRepresentable applies.

The utility can handle arbitrarily nested lists, sets, arrays, etc. For a complete list of types it can handle, refer to accumulateObject(ByteAccumulator, Object).

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>>	annotationClassList Contains all annotations used to mark fields that should be automatically accumulated by this class.
protected static byte	nullSymbol The symbol used to represent null values in unique byte representations.

Constructor Summary

Constructors

Constructor and Description
AnnotatedUbrUtil()

Method Summary

Modifier and Type	Method and Description
static ByteAccumulator	autoAccumulate(ByteAccumulator accumulator, java.lang.Object instance) Adds all @UniqueByteRepresented-annotated fields within the given instance object to the accumulator.

Methods inherited from class java.lang.Object

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

Field Detail

nullSymbol

protected static final byte nullSymbol

The symbol used to represent null values in unique byte representations.

See Also:

Constant Field Values

annotationClassList

protected static final java.util.List<java.lang.Class<? extends java.lang.annotation.Annotation>> annotationClassList

Contains all annotations used to mark fields that should be automatically accumulated by this class.

Constructor Detail

AnnotatedUbrUtil

public AnnotatedUbrUtil()

Method Detail

autoAccumulate

public static ByteAccumulator autoAccumulate(ByteAccumulator accumulator,
                                             java.lang.Object instance)

Adds all @UniqueByteRepresented-annotated fields within the given instance object to the accumulator.

Parameters:

accumulator - ByteAccumulator to append to

instance - instance of class with annotated member variables

Returns:

the given accumulator (for chaining)