Package kieker.common.record.misc
Class KiekerMetadataRecord
java.lang.Object
kieker.common.record.AbstractMonitoringRecord
kieker.common.record.misc.KiekerMetadataRecord
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<IMonitoringRecord>
,IMonitoringRecord
public class KiekerMetadataRecord extends AbstractMonitoringRecord
- Since:
- 1.7
- Author:
- Jan Waller API compatibility: Kieker 1.15.0
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CONTROLLER_NAME
static boolean
DEBUG_MODE
static int
EXPERIMENT_ID
static java.lang.String
HOSTNAME
static java.lang.String
NO_CONTROLLERNAME
user-defined constants.static java.lang.String
NO_HOSTNAME
static java.lang.String
NO_TIMESOURCE
static java.lang.String
NO_TIMEUNIT
static long
NUMBER_OF_RECORDS
static int
SIZE
Descriptive definition of the serialization size of the record.static long
TIME_OFFSET
static java.lang.String
TIME_UNIT
static java.lang.Class<?>[]
TYPES
static java.lang.String[]
VALUE_NAMES
property name array.static java.lang.String
VERSION
default constants.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 Description KiekerMetadataRecord(java.lang.String version, java.lang.String controllerName, java.lang.String hostname, int experimentId, boolean debugMode, long timeOffset, java.lang.String timeUnit, long numberOfRecords)
Creates a new instance of this class using the given parameters.KiekerMetadataRecord(IValueDeserializer deserializer)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object obj)
Performs a null-check, a this-check, and a class-check.java.lang.String
getControllerName()
int
getExperimentId()
java.lang.String
getHostname()
long
getNumberOfRecords()
int
getSize()
This method should deliver the size of a binary representation of this record.long
getTimeOffset()
java.lang.String
getTimeUnit()
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.java.lang.String
getVersion()
int
hashCode()
boolean
isDebugMode()
void
serialize(IValueSerializer serializer)
This method serializes this record using the given serializer.java.lang.String
toString()
Creates a string representation of this record.
This method should not be used for serialization purposes since this is not the purpose of Object's toString method.Methods inherited from class kieker.common.record.AbstractMonitoringRecord
checkArray, classForName, compareTo, createFromDeserializer, fromStringArrayToTypedArray2, getLoggingTimestamp, isNotEqual, isNotEqual, setLoggingTimestamp, typesForClass
-
Field Details
-
SIZE
public static final int SIZEDescriptive definition of the serialization size of the record.- See Also:
- Constant Field Values
-
TYPES
public static final java.lang.Class<?>[] TYPES -
NO_CONTROLLERNAME
public static final java.lang.String NO_CONTROLLERNAMEuser-defined constants.- See Also:
- Constant Field Values
-
NO_HOSTNAME
public static final java.lang.String NO_HOSTNAME- See Also:
- Constant Field Values
-
NO_TIMESOURCE
public static final java.lang.String NO_TIMESOURCE- See Also:
- Constant Field Values
-
NO_TIMEUNIT
public static final java.lang.String NO_TIMEUNIT- See Also:
- Constant Field Values
-
VALUE_NAMES
public static final java.lang.String[] VALUE_NAMESproperty name array. -
VERSION
public static final java.lang.String VERSIONdefault constants. -
CONTROLLER_NAME
public static final java.lang.String CONTROLLER_NAME- See Also:
- Constant Field Values
-
HOSTNAME
public static final java.lang.String HOSTNAME- See Also:
- Constant Field Values
-
EXPERIMENT_ID
public static final int EXPERIMENT_ID- See Also:
- Constant Field Values
-
DEBUG_MODE
public static final boolean DEBUG_MODE- See Also:
- Constant Field Values
-
TIME_OFFSET
public static final long TIME_OFFSET- See Also:
- Constant Field Values
-
TIME_UNIT
public static final java.lang.String TIME_UNIT- See Also:
- Constant Field Values
-
NUMBER_OF_RECORDS
public static final long NUMBER_OF_RECORDS- See Also:
- Constant Field Values
-
-
Constructor Details
-
KiekerMetadataRecord
public KiekerMetadataRecord(java.lang.String version, java.lang.String controllerName, java.lang.String hostname, int experimentId, boolean debugMode, long timeOffset, java.lang.String timeUnit, long numberOfRecords)Creates a new instance of this class using the given parameters.- Parameters:
version
- versioncontrollerName
- controllerNamehostname
- hostnameexperimentId
- experimentIddebugMode
- debugModetimeOffset
- timeOffsettimeUnit
- timeUnitnumberOfRecords
- numberOfRecords
-
KiekerMetadataRecord
- Parameters:
deserializer
- The deserializer to use- Throws:
RecordInstantiationException
- when the record could not be deserialized
-
-
Method Details
-
serialize
This method serializes this record using the given serializer.- Parameters:
serializer
- The serializer to serialize the record with. *- Throws:
java.nio.BufferOverflowException
- If the underlying buffer has insufficient capacity to store this record
-
getValueTypes
public java.lang.Class<?>[] getValueTypes()This method delivers an array with the classes of the single values for the record.- Returns:
- The types of the values. This returned array should be treated readonly.
-
getValueNames
public java.lang.String[] getValueNames()This method delivers an array containing the value names of the record.- Returns:
- The types of the values. This returned array should be treated readonly.
-
getSize
public int getSize()This method should deliver the size of a binary representation of this record.- Returns:
- The size.
-
equals
public boolean equals(java.lang.Object obj)Performs a null-check, a this-check, and a class-check. Moreover, it checks each attribute for equality.
- Overrides:
equals
in classAbstractMonitoringRecord
-
hashCode
public int hashCode()- Overrides:
hashCode
in classAbstractMonitoringRecord
-
getVersion
public final java.lang.String getVersion() -
getControllerName
public final java.lang.String getControllerName() -
getHostname
public final java.lang.String getHostname() -
getExperimentId
public final int getExperimentId() -
isDebugMode
public final boolean isDebugMode() -
getTimeOffset
public final long getTimeOffset() -
getTimeUnit
public final java.lang.String getTimeUnit() -
getNumberOfRecords
public final long getNumberOfRecords() -
toString
public java.lang.String toString()Creates a string representation of this record.
This method should not be used for serialization purposes since this is not the purpose of Object's toString method.- Specified by:
toString
in interfaceIMonitoringRecord
- Overrides:
toString
in classjava.lang.Object
- Returns:
- A (human readable) string of this record.
-