de.uni_hildesheim.sse.monitoring.runtime.recordingStrategiesElements

Class IoElement

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.recordingStrategiesElements.RecordingStrategiesElement

de.uni_hildesheim.sse.monitoring.runtime.recordingStrategiesElements.IoElement

All Implemented Interfaces:

Poolable<IoElement>

public class IoElement
extends RecordingStrategiesElement
implements Poolable<IoElement>

Defines a ReadIoElement.

Since:

1.00

Version:

1.00

Author:

Stephan Dederichs, Aike Sass

Field Summary

Fields

Modifier and Type	Field and Description
private int	bytes Stores the bytes.
private java.lang.String	caller Stores the caller.
static ObjectPool<IoElement>	POOL Defines an object pool for this class.
private java.lang.String	recId Stores the recId.
private long	threadId Stores the identification of the calling thread.
private StreamType	type Stores the type.
private boolean	write Write (true) or read (false).

Constructor Summary

Constructors

Constructor and Description
IoElement() Creates a new empty instance.
IoElement(java.lang.String recId, java.lang.String caller, long threadId, int bytes, StreamType type, boolean write) Creates a new instance with the given parameters.

Method Summary

Modifier and Type	Method and Description
void	clear() If a pool is used this method is for releasing the element from the pool.
IoElement	create() Creates a further instance of this instances (intended as factory method to be executed on a prototypical instance).
int	getBytes() Getter for the bytes.
java.lang.String	getCaller() Getter for the caller.
int	getIdentification() Returns the unambiguous identification of the element.
java.lang.String	getRecId() Getter for the recId.
long	getThreadId() Getter for the tread id.
StreamType	getType() Getter for the type.
boolean	isWrite() Getter for write.
void	process(RecorderStrategy strategy) Hands the information of the element to the RecorderStrategy.
void	read(java.io.DataInputStream in) Reads this instance from the given input stream.
void	release() Release this element from the pool if this instance is Poolable.
void	send(java.io.DataOutputStream out) Writes this instance to the given output stream.
void	setBytes(int bytes) Setter for the bytes.
void	setCaller(java.lang.String caller) Setter for the caller.
void	setRecId(java.lang.String recId) Setter for the recId.
void	setThreadId(long threadId) Setter for the thread id.
void	setType(StreamType type) Setter for the type.
void	setWrite(boolean write) Setter for write or read access.

Methods inherited from class java.lang.Object

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

Field Detail

POOL

public static final ObjectPool<IoElement> POOL

Defines an object pool for this class.

recId

private java.lang.String recId

Stores the recId.

bytes

private int bytes

Stores the bytes.

type

private StreamType type

Stores the type.

threadId

private long threadId

Stores the identification of the calling thread.

caller

private java.lang.String caller

Stores the caller.

write

private boolean write

Write (true) or read (false).

Constructor Detail

IoElement

IoElement()

Creates a new empty instance.

Since:

1.00

IoElement

public IoElement(java.lang.String recId,
                 java.lang.String caller,
                 long threadId,
                 int bytes,
                 StreamType type,
                 boolean write)

Creates a new instance with the given parameters.

Parameters:

recId - the recId

caller - optional class name of the calling class

threadId - the identification of the calling thread

bytes - the bytes

type - the type

write - whether it is a write or read access

Since:

1.00

Method Detail

getRecId

public java.lang.String getRecId()

Getter for the recId.

Returns:

the recId

Since:

1.00

setRecId

public void setRecId(java.lang.String recId)

Setter for the recId.

Parameters:

recId - the recId to set

Since:

1.00

getBytes

public int getBytes()

Getter for the bytes.

Returns:

the bytes

Since:

1.00

setBytes

public void setBytes(int bytes)

Setter for the bytes.

Parameters:

bytes - the bytes to set

Since:

1.00

getType

public StreamType getType()

Getter for the type.

Returns:

the type

Since:

1.00

setType

public void setType(StreamType type)

Setter for the type.

Parameters:

type - the type to set

Since:

1.00

send

public void send(java.io.DataOutputStream out)
          throws java.io.IOException

Writes this instance to the given output stream.

Specified by:

send in class RecordingStrategiesElement

Parameters:

out - the output stream

Throws:

java.io.IOException - in case of any I/O error or problem

read

public void read(java.io.DataInputStream in)
          throws java.io.IOException

Reads this instance from the given input stream.

Specified by:

read in class RecordingStrategiesElement

Parameters:

in - the input stream

Throws:

java.io.IOException - in case of any I/O error or problem

getIdentification

public int getIdentification()

Returns the unambiguous identification of the element.

Specified by:

getIdentification in class RecordingStrategiesElement

Returns:

the identification of the element

process

public void process(RecorderStrategy strategy)

Hands the information of the element to the RecorderStrategy.

Specified by:

process in class RecordingStrategiesElement

Parameters:

strategy - the RecorderStrategy

clear

public void clear()

If a pool is used this method is for releasing the element from the pool.

Specified by:

clear in interface Poolable<IoElement>

Specified by:

clear in class RecordingStrategiesElement

release

public void release()

Release this element from the pool if this instance is Poolable.

Overrides:

release in class RecordingStrategiesElement

create

public IoElement create()

Description copied from interface: Poolable

Creates a further instance of this instances (intended as factory method to be executed on a prototypical instance).

Specified by:

create in interface Poolable<IoElement>

Returns:

the created instance

setThreadId

public void setThreadId(long threadId)

Setter for the thread id.

Parameters:

threadId - the id to be set

setCaller

public void setCaller(java.lang.String caller)

Setter for the caller.

Parameters:

caller - the caller to be set

setWrite

public void setWrite(boolean write)

Setter for write or read access.

Parameters:

write - true if write access else false

getThreadId

public long getThreadId()

Getter for the tread id.

Returns:

the id of the thread

getCaller

public java.lang.String getCaller()

Getter for the caller.

Returns:

the caller

isWrite

public boolean isWrite()

Getter for write.

Returns:

true if it is a write access else false