kieker.common.record.system
Class ResourceUtilizationRecord

java.lang.Object
  kieker.common.record.AbstractMonitoringRecord
      kieker.common.record.system.ResourceUtilizationRecord

All Implemented Interfaces:

Serializable, Comparable<IMonitoringRecord>, IMonitoringRecord, IMonitoringRecord.BinaryFactory, IMonitoringRecord.Factory

public class ResourceUtilizationRecord
extends AbstractMonitoringRecord
implements IMonitoringRecord.Factory, IMonitoringRecord.BinaryFactory

Since:

1.3

Author:

Andre van Hoorn, 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

static int	SIZE
static 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

ResourceUtilizationRecord(ByteBuffer buffer, IRegistry<String> stringRegistry)
This constructor converts the given array into a record.

ResourceUtilizationRecord(long timestamp, String hostname, String resourceName, double utilization)
Creates a new instance of this class using the given parameters.

ResourceUtilizationRecord(Object[] values)
This constructor converts the given array into a record.

Method Summary

String	getHostname()
String	getResourceName()
int	getSize() This method should deliver the size of a binary representation of this record.
long	getTimestamp()
double	getUtilization()
Class<?>[]	getValueTypes() This method should deliver an array with the classes of the single values for the record.
void	initFromArray(Object[] values) Deprecated. This record uses the IMonitoringRecord.Factory mechanism. Hence, this method is not implemented.
void	initFromBytes(ByteBuffer buffer, IRegistry<String> stringRegistry) Deprecated. This record uses the IMonitoringRecord.BinaryFactory mechanism. Hence, this method is not implemented.
Object[]	toArray() This method should deliver an array containing the content of the record.
void	writeBytes(ByteBuffer buffer, IRegistry<String> stringRegistry) This method should deliver an byte array containing the content of the record.

Methods inherited from class kieker.common.record.AbstractMonitoringRecord

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

SIZE

public static final int SIZE

See Also:

Constant Field Values

TYPES

public static final Class<?>[] TYPES

Constructor Detail

ResourceUtilizationRecord

public ResourceUtilizationRecord(long timestamp,
                                 String hostname,
                                 String resourceName,
                                 double utilization)

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

Parameters:

timestamp - The timestamp for the record.

hostname - The hostname (the resource belongs to) for the record.

resourceName - The name of the resource.

utilization - The value of utilization. The value should be in the range [0,1]

ResourceUtilizationRecord

public ResourceUtilizationRecord(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.

ResourceUtilizationRecord

public ResourceUtilizationRecord(ByteBuffer buffer,
                                 IRegistry<String> stringRegistry)
                          throws BufferUnderflowException

This constructor converts the given array into a record.

Parameters:

buffer - The bytes for the record.

Throws:

BufferUnderflowException - if buffer not sufficient

Method Detail

toArray

public 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.

writeBytes

public void writeBytes(ByteBuffer buffer,
                       IRegistry<String> stringRegistry)
                throws BufferOverflowException

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

Specified by:

writeBytes in interface IMonitoringRecord

Parameters:

buffer - The used ByteBuffer with sufficient capacity

stringRegistry - Usually the associated MonitoringController

Throws:

BufferOverflowException - if buffer not sufficient

initFromArray

@Deprecated
public final void initFromArray(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.

initFromBytes

@Deprecated
public final void initFromBytes(ByteBuffer buffer,
                                           IRegistry<String> stringRegistry)
                         throws BufferUnderflowException

Deprecated. This record uses the IMonitoringRecord.BinaryFactory 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.writeBytes(ByteBuffer, IRegistry).

Specified by:

initFromBytes in interface IMonitoringRecord

Parameters:

buffer - The bytes for the record.

stringRegistry - The Registry storing the strings.

Throws:

BufferUnderflowException - if buffer not sufficient

getValueTypes

public Class<?>[] getValueTypes()

This method should deliver 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()

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.

getTimestamp

public final long getTimestamp()

Returns:

the timestamp

getHostname

public final String getHostname()

Returns:

the hostname

getResourceName

public final String getResourceName()

Returns:

the resourceName

getUtilization

public final double getUtilization()

Returns:

the utilization