com.att.inno.env

Class TimeTaken

java.lang.Object

com.att.inno.env.TimeTaken

public abstract class TimeTaken
extends Object

TimeTaken

This simple interface allows for many different kinds of Audit Logs to be accomplished, by assuming that the creation of this object indicates "start", and the calling of "done" ends. The implementor of this class can easily be stored in efficient mechanisms to minimize impact of Auditing on performance.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	end
int	flag
String	name
protected long	size
long	start

Constructor Summary

Constructors

Constructor and Description
TimeTaken(String name, int flag) The name is as it will appear when written to output (abstract method) The flag is an integer which can be System type (XML, REMOTE, etc), or End User defined for reporting purposes

Method Summary

Modifier and Type	Method and Description
void	done() Call this when process is done to state ending time.
long	end() Give readonly access to End, which isn't final
float	millis() Time is taken in NanoSeconds.
abstract void	output(StringBuilder sb) Write self to a String Builder (for making Audits)
void	size(long theSize) For sizable contents, set the size.
String	toString() For Debugging

Methods inherited from class java.lang.Object

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

Field Detail

start

public final long start

end

protected long end

size

protected long size

flag

public final int flag

name

public final String name

Constructor Detail

TimeTaken

public TimeTaken(String name,
                 int flag)

The name is as it will appear when written to output (abstract method) The flag is an integer which can be System type (XML, REMOTE, etc), or End User defined for reporting purposes

Parameters:

name -

flag -

Method Detail

done

public void done()

Call this when process is done to state ending time.

It is exceedingly prudent to wrap the process called with a try-finally:

   TimeTaken tt = env.startSubTime();
   try {
       process.me(); // code to be timed.
   } finally {
         tt.done();
   }
 

size

public void size(long theSize)

For sizable contents, set the size. Implementations can simply write a no-op if they don't wish to store the size.

Parameters:

size -

end

public long end()

Give readonly access to End, which isn't final

Returns:

millis

public float millis()

Time is taken in NanoSeconds. This method converts to decimals of Milliseconds

Returns:

output

public abstract void output(StringBuilder sb)

Write self to a String Builder (for making Audits)

Parameters:

sb -

toString

public String toString()

For Debugging

Overrides:

toString in class Object