com.allanbank.mongodb

Class ProfilingStatus

java.lang.Object

com.allanbank.mongodb.ProfilingStatus

All Implemented Interfaces:

Serializable, Comparable<ProfilingStatus>

public class ProfilingStatus
extends Object
implements Comparable<ProfilingStatus>, Serializable

ProfilingStatus provides a container for the ProfilingStatus.Level and number of milliseconds beyond which to consider an operation to be slow.

See Also:

Serialized Form

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2012-2013, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProfilingStatus.Level Level provides the set of available profiling levels provided by the MongoDB server.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_SLOW_MS The default threshold (100L )for the number of milliseconds beyond considering an operation slow.
static ProfilingStatus	OFF The off profiling state.
static ProfilingStatus	ON The all profiling state.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ProfilingStatus other)
boolean	equals(Object object)
ProfilingStatus.Level	getLevel() Returns the profiling level to use.
long	getSlowMillisThreshold() Returns the number of milliseconds beyond which to consider an operation to be slow.
int	hashCode()
static ProfilingStatus	slow(int slowMillis) Creates a profiling state to profile operations taking more than slowMillis to complete.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SLOW_MS

public static final long DEFAULT_SLOW_MS

The default threshold (100L )for the number of milliseconds beyond considering an operation slow.

See Also:

Constant Field Values

OFF

public static final ProfilingStatus OFF

The off profiling state.

ON

public static final ProfilingStatus ON

The all profiling state.

Method Detail

slow

public static final ProfilingStatus slow(int slowMillis)

Creates a profiling state to profile operations taking more than slowMillis to complete.

Parameters:

slowMillis - The number of milliseconds beyond which to consider an operation to be slow.

Returns:

The slow profiling state.

compareTo

public int compareTo(ProfilingStatus other)

Overridden to return an ordering based on the tuple ordering of (level, slowMs).

Specified by:

compareTo in interface Comparable<ProfilingStatus>

equals

public boolean equals(Object object)

Overridden to compare this object to the passed object.

Overrides:

equals in class Object

getLevel

public ProfilingStatus.Level getLevel()

Returns the profiling level to use.

Returns:

The profiling level to use.

getSlowMillisThreshold

public long getSlowMillisThreshold()

Returns the number of milliseconds beyond which to consider an operation to be slow.

Returns:

The number of milliseconds beyond which to consider an operation to be slow.

hashCode

public int hashCode()

Overridden to generate a suitable hash of the objects state.

Overrides:

hashCode in class Object

toString

public String toString()

Overridden to return a readable form of the object.

Overrides:

toString in class Object