de.christofreichardt.diagnosis.TracingContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tracelogger Show documentation

A trace tool which produces clearly arranged logs by indenting the trace messages depending on the depth of the call stack.

There is a newer version: 1.10.0

Show newest version

/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */

package de.christofreichardt.diagnosis;

import java.util.ArrayDeque;
import java.util.Deque;

/**
 * The tracing context of one particular thread. It manages the stack of the to be observed methods.
 * For internal use.
 * 
 * @author Christof Reichardt
 */
public class TracingContext {
  
  private int debugLevel = -1;
  private boolean online = false;
  private final Deque methodStack = new ArrayDeque<>();
  private boolean corrupted = false;

  /**
   * Creates a new instance of TracingContext by evaluating the given parameter.
   * 
   * @param debugLevel limites the part of the stack for which output will generated
   * @param online if true output will generated until the denoted limit, otherwise no output will generated at all
   */
  TracingContext(int debugLevel, boolean online) {
    this.debugLevel = debugLevel;
    this.online = online;
  }

  /**
   * Creates a new instance of TracingContext by evaluating the given DebugConfig object.
   * 
   * @param debugConfig a simple bean with debugLevel and online properties
   */
  TracingContext(DebugConfig debugConfig) {
    this.debugLevel = debugConfig.getLevel();
    this.online = debugConfig.isOnline();
  }

  /**
   * @return the debugLevel
   */
  int getDebugLevel() {
    return debugLevel;
  }

  /**
   * @param debugLevel the debugLevel to set
   */
  void setDebugLevel(int debugLevel) {
    this.debugLevel = debugLevel;
  }

  /**
   * @return the online
   */
  boolean isOnline() {
    return online & !corrupted;
  }

  /**
   * @param online the online to set
   */
  void setOnline(boolean online) {
    this.online = online;
  }

  /**
   * @return the methodStack
   */
  Deque getMethodStack() {
    return methodStack;
  }

  /**
   * Indicates that the method stack is corrupted, for example has overflowed.
   * 
   * @return the corrupted
   */
  boolean isCorrupted() {
    return corrupted;
  }

  /**
   * @param corrupted the corrupted to set
   */
  void setCorrupted(boolean corrupted) {
    this.corrupted = corrupted;
  }
}