net.digitaltsunami.tmeter.level

Class ThresholdTimerLevel<E extends Enum<E>>

java.lang.Object

net.digitaltsunami.tmeter.level.ThresholdTimerLevel<E>

All Implemented Interfaces:

TimerLevel

public class ThresholdTimerLevel<E extends Enum<E>>
extends Object
implements TimerLevel

TimerLevel representing a TimerLevelType.THRESHOLD type backed by an enumeration. Timer levels of this type are threshold and will be active only on a match equal to or above the backing enumeration.

As an example, use of an enum of type TLevel with values: MAIN, and DETAIL. If a CategoryTimerLevel is created by using

 
     enum TLevel {MAIN,DETAIL;}
     public static final TimerLevel MAIN = new CategoryTimerLevel(TLevel.MAIN);
     public static final TimerLevel DETAIL = new CategoryTimerLevel(TLevel.DETAIL);
 
 

Usage:

 
  TimeTracker.enableTimerLevel(MAIN);
  Timer tLogin = TimeTracker.startRecording(MAIN, "Login");
  Timer tSession = TimeTracker.startRecording(DETAIL, "CheckExistingSession");  // Would not be recorded
 
 

Another method is to create an enum that extends TimerLevel and uses this CategoryTimerLevel to provide the implementation.

 
  public enum TrackLevel implements TimerLevel {
      MAIN(),
      DETAIL();
 
      CategoryTimerLevel timerLevel;
 
      TrackLevel() { timerLevel = new CategoryTimerLevel(this); }
      public boolean isEnabled(TimerLevel level) { return timerLevel.isEnabled(level); }
      public boolean isEnabled(TimerLevel... levels) { return timerLevel.isEnabled(levels); }
      public TimerLevelType getLevelType() { return timerLevel.getLevelType(); }
      public Object getGroup() { return timerLevel.getGroup(); }
  }
 
 

Usage:

 
  TimeTracker.enableTimerLevel(TrackLevel.MAIN);
  Timer tLogin = TimeTracker.startRecording(TrackLevel.MAIN, "Login");
  Timer tSession = TimeTracker.startRecording(TrackLevel.DETAIL, "CheckExistingSession");  // Would not be recorded
 
 

Author:

dhagberg

Constructor Summary

Constructors

Constructor and Description
ThresholdTimerLevel(E level)

Method Summary

Methods

Modifier and Type	Method and Description
Object	getGroup() Return the group to which this timer level belongs.
TimerLevelType	getLevelType() Return the type of level that this level represents.
boolean	isEnabled(TimerLevel... oLevels) Compare all provided levels against this level and return true if any of the levels is enabled for this level.
boolean	isEnabled(TimerLevel oLevel) Return true if the provided level is enabled for this level.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThresholdTimerLevel

public ThresholdTimerLevel(E level)

Method Detail

isEnabled

public boolean isEnabled(TimerLevel oLevel)

Description copied from interface: TimerLevel

Return true if the provided level is enabled for this level.

Specified by:

isEnabled in interface TimerLevel

Parameters:

oLevel - to compare against this level.

Returns:

true if the level is enabled, false otherwise.

isEnabled

public boolean isEnabled(TimerLevel... oLevels)

Description copied from interface: TimerLevel

Compare all provided levels against this level and return true if any of the levels is enabled for this level.

Specified by:

isEnabled in interface TimerLevel

Parameters:

oLevels - list of levels to compare against this level.

Returns:

true if one or more of the levels is enabled or false if none of the provided label are enabled.

getLevelType

public TimerLevelType getLevelType()

Description copied from interface: TimerLevel

Return the type of level that this level represents.

Specified by:

getLevelType in interface TimerLevel

Returns:

instance of TimerLevelType

getGroup

public Object getGroup()

Description copied from interface: TimerLevel

Return the group to which this timer level belongs. Used to group for Set operations. Must be unique. Good examples are declaring class for enum.

Specified by:

getGroup in interface TimerLevel