kieker.common.record.misc

Class RegistryRecord

java.lang.Object

kieker.common.record.AbstractMonitoringRecord

kieker.common.record.misc.RegistryRecord

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IMonitoringRecord>, IMonitoringRecord, IMonitoringRecord.BinaryFactory, IMonitoringRecord.Factory

public final class RegistryRecord
extends AbstractMonitoringRecord
implements IMonitoringRecord.Factory, IMonitoringRecord.BinaryFactory

Record used to associate Objects (typically Strings) with unique ids.

Since:

1.5

Author:

Jan Waller

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface kieker.common.record.IMonitoringRecord

IMonitoringRecord.BinaryFactory, IMonitoringRecord.Factory

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLASS_ID
static java.lang.String	ENCODING
static int	SIZE
static java.lang.Class<?>[]	TYPES

Fields inherited from class kieker.common.record.AbstractMonitoringRecord

TYPE_SIZE_BOOLEAN, TYPE_SIZE_BYTE, TYPE_SIZE_CHARACTER, TYPE_SIZE_DOUBLE, TYPE_SIZE_FLOAT, TYPE_SIZE_INT, TYPE_SIZE_LONG, TYPE_SIZE_SHORT, TYPE_SIZE_STRING

Constructor Summary

Constructors

Constructor and Description
RegistryRecord(int id, java.lang.String string) Creates a new instance of this class using the given parameters.
RegistryRecord(IValueDeserializer deserializer) This constructor converts the given array into a record.
RegistryRecord(java.lang.Object[] values) This constructor converts the given array into a record.

Method Summary

Methods

Modifier and Type	Method and Description
int	getId()
int	getSize() This method should deliver the size of a binary representation of this record.
byte[]	getStrBytes()
java.lang.String	getString()
java.lang.String[]	getValueNames() This method delivers an array containing the value names of the record.
java.lang.Class<?>[]	getValueTypes() This method delivers an array with the classes of the single values for the record.
void	initFromArray(java.lang.Object[] values) Deprecated. This record uses the IMonitoringRecord.Factory mechanism. Hence, this method is not implemented.
static void	registerRecordInRegistry(java.nio.ByteBuffer buffer, ILookup<java.lang.String> stringRegistry) Static function used to register strings stored in a byte buffer as string in the string registry with the proper id.
void	registerStrings(IRegistry<java.lang.String> stringRegistry) Registers the string attributes of the record at the given stringRegistry.
void	serialize(IValueSerializer serializer) This method serializes this record using the given serializer.
java.lang.Object[]	toArray() This method should deliver an array containing the content of the record.

Methods inherited from class kieker.common.record.AbstractMonitoringRecord

checkArray, classForName, compareTo, createFromArray, createFromArray, createFromDeserializer, createFromStringArray, equals, fromStringArrayToTypedArray, getLoggingTimestamp, hashCode, isNotEqual, isNotEqual, setLoggingTimestamp, toString, typesForClass

Methods inherited from class java.lang.Object

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

Field Detail

SIZE

public static final int SIZE

See Also:

Constant Field Values

TYPES

public static final java.lang.Class<?>[] TYPES

ENCODING

public static final java.lang.String ENCODING

See Also:

Constant Field Values

CLASS_ID

public static final int CLASS_ID

See Also:

Constant Field Values

Constructor Detail

RegistryRecord

public RegistryRecord(int id,
              java.lang.String string)

Creates a new instance of this class using the given parameters.

Parameters:

id - The ID.

string - The string.

RegistryRecord

public RegistryRecord(java.lang.Object[] values)

This constructor converts the given array into a record. It is recommended to use the array which is the result of a call to toArray().

Parameters:

values - The values for the record.

RegistryRecord

public RegistryRecord(IValueDeserializer deserializer)
               throws java.nio.BufferUnderflowException

This constructor converts the given array into a record.

Parameters:

deserializer - The deserializer to decode the record with.

Throws:

java.nio.BufferUnderflowException - if buffer not sufficient

Method Detail

toArray

public java.lang.Object[] toArray()

This method should deliver an array containing the content of the record. It should be possible to convert this array later into a record again.

Specified by:

toArray in interface IMonitoringRecord

Returns:

An array with the values of the record.

registerStrings

public void registerStrings(IRegistry<java.lang.String> stringRegistry)

Registers the string attributes of the record at the given stringRegistry.

Specified by:

registerStrings in interface IMonitoringRecord

serialize

public void serialize(IValueSerializer serializer)
               throws java.nio.BufferOverflowException

This method serializes this record using the given serializer.

Specified by:

serialize in interface IMonitoringRecord

Parameters:

serializer - The serializer to serialize the record with. *

Throws:

java.nio.BufferOverflowException - If the underlying buffer has insufficient capacity to store this record

initFromArray

@Deprecated
public final void initFromArray(java.lang.Object[] values)

Deprecated. This record uses the IMonitoringRecord.Factory mechanism. Hence, this method is not implemented.

This method should initialize the record based on the given values. The array should be one of those resulting from a call to IMonitoringRecord.toArray().

Specified by:

initFromArray in interface IMonitoringRecord

Parameters:

values - The values for the record.

getValueTypes

public java.lang.Class<?>[] getValueTypes()

This method delivers an array with the classes of the single values for the record.

Specified by:

getValueTypes in interface IMonitoringRecord

Returns:

The types of the values. This returned array should be treated readonly.

See Also:

IMonitoringRecord.toArray()

getValueNames

public java.lang.String[] getValueNames()

Description copied from interface: IMonitoringRecord

This method delivers an array containing the value names of the record.

Specified by:

getValueNames in interface IMonitoringRecord

Returns:

The types of the values. This returned array should be treated readonly.

See Also:

IMonitoringRecord.toArray()

getSize

public int getSize()

This method should deliver the size of a binary representation of this record.

Specified by:

getSize in interface IMonitoringRecord

Returns:

The size.

getStrBytes

public final byte[] getStrBytes()

Returns:

the String as byte[]

getId

public final int getId()

Returns:

the id

getString

public final java.lang.String getString()

Returns:

the string

registerRecordInRegistry

public static final void registerRecordInRegistry(java.nio.ByteBuffer buffer,
                            ILookup<java.lang.String> stringRegistry)
                                           throws java.nio.BufferOverflowException

Static function used to register strings stored in a byte buffer as string in the string registry with the proper id.

Parameters:

buffer - the byte buffer containing the string

stringRegistry - the registry where the string is stored

Throws:

java.nio.BufferOverflowException - if the length encoded in the buffer exceeds the buffers boundary