Module io.github.tonywasher.joceanus.oceanus

Package io.github.tonywasher.joceanus.oceanus.profile

Class OceanusProfile

java.lang.Object

io.github.tonywasher.joceanus.oceanus.profile.OceanusProfile

public class OceanusProfile
extends Object

Profile data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OceanusProfile.OceanusProfileStatus	Status of timer.

Constructor Summary

Constructors

Constructor	Description
OceanusProfile(String pName)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	end()	End the task.
OceanusProfile	getActiveTask()	Obtain the currently active task.
OceanusDecimal	getElapsed()	Obtain the elapsed time of the profile.
OceanusDecimal	getHidden()	Obtain the hidden time of the profile.
String	getName()	Obtain the name of the profile.
OceanusProfile.OceanusProfileStatus	getStatus()	Obtain the status of the profile.
boolean	isRunning()	is the task running?
OceanusProfile	startTask(String pName)	Start a new subTask.
Iterator<OceanusProfile>	subTaskIterator()	Obtain the subtask iterator.

Methods inherited from class java.lang.Object

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

Constructor Details

OceanusProfile

public OceanusProfile(String pName)

Constructor.

Parameters:

pName - the name of the step

Method Details

getName

public String getName()

Obtain the name of the profile.

Returns:

the name

getStatus

public OceanusProfile.OceanusProfileStatus getStatus()

Obtain the status of the profile.

Returns:

the status

getElapsed

public OceanusDecimal getElapsed()

Obtain the elapsed time of the profile.

Returns:

the elapsedTime

getHidden

public OceanusDecimal getHidden()

Obtain the hidden time of the profile.

Returns:

the hiddenTime

subTaskIterator

public Iterator<OceanusProfile> subTaskIterator()

Obtain the subtask iterator.

Returns:

the iterator

startTask

public OceanusProfile startTask(String pName)

Start a new subTask.

Parameters:

pName - the name of the subTask

Returns:

the new task

end

public void end()

End the task.

isRunning

public boolean isRunning()

is the task running?

Returns:

true/false.

getActiveTask

public OceanusProfile getActiveTask()

Obtain the currently active task.

Returns:

the task