Package com.dalsemi.onewire.debug

Class Debug

java.lang.Object
com.dalsemi.onewire.debug.Debug
public class Debug extends Object

This class is intended to help both developers of the 1-Wire API for Java and developers using the 1-Wire API for Java to have a standard method for printing debug messages. Applications that want to see debug messages should call the setDebugMode(boolean) method. Classes that want to print information under debugging circumstances should call the debug(String) method.

Debug printing is turned off by default.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Debug()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static final void
    debug(String x)
    Prints the specified java.lang.String object if debug mode is enabled.
    static final void
    debug(String lbl, byte[] bytes)
    Prints the specified array of bytes with a given label if debug mode is enabled.
    static final void
    debug(String lbl, byte[] bytes, int offset, int length)
    Prints the specified array of bytes with a given label if debug mode is enabled.
    static final void
    debug(String lbl, Throwable t)
    Prints the specified exception with a given label if debug mode is enabled.
    static final boolean
    getDebugMode()
    Gets the debug printing mode for this application.
    static final void
    setDebugMode(boolean onoff)
    Sets the debug printing mode for this application.
    static final void
    setPrintStream(PrintStream outStream)
    Sets the output stream for printing the debug info.
    static final void
    stackTrace()
    Prints out an exception stack trace for debugging purposes.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Debug

      public Debug()

  • Method Details

    • setDebugMode

      public static final void setDebugMode(boolean onoff)
      Sets the debug printing mode for this application.
      Parameters:
      onoff - true to see debug messages, false to suppress them

    • getDebugMode

      public static final boolean getDebugMode()
      Gets the debug printing mode for this application.
      Returns:
      true indicates debug messages are on, false suppresses them.

    • setPrintStream

      public static final void setPrintStream(PrintStream outStream)
      Sets the output stream for printing the debug info.
      Parameters:
      outStream - the output stream for printing the debug info.

    • debug

      public static final void debug(String x)
      Prints the specified java.lang.String object if debug mode is enabled. This method calls PrintStream.println(String), and pre-pends the String ">> " to the message, so that if a program were to call (when debug mode was enabled): 
       com.dalsemi.onewire.debug.Debug.debug("Some notification...");
      the resulting output would look like: 
           >> Some notification...
      Parameters:
      x - the message to print out if in debug mode

    • debug

      public static final void debug(String lbl, byte[] bytes)
      Prints the specified array of bytes with a given label if debug mode is enabled. This method calls PrintStream.println(String), and pre-pends the String ">> " to the message, so that if a program were to call (when debug mode was enabled): 
       com.dalsemi.onewire.debug.Debug.debug("Some notification...", myBytes);
      the resulting output would look like: 
           >> my label
     >>   FF F1 F2 F3 F4 F5 F6 FF
      Parameters:
      lbl - the message to print out above the array
      bytes - the byte array to print out

    • debug

      public static final void debug(String lbl, byte[] bytes, int offset, int length)
      Prints the specified array of bytes with a given label if debug mode is enabled. This method calls PrintStream.println(String), and pre-pends the String ">> " to the message, so that if a program were to call (when debug mode was enabled): 
       com.dalsemi.onewire.debug.Debug.debug("Some notification...", myBytes, 0, 8);
      the resulting output would look like: 
           >> my label
     >> FF F1 F2 F3 F4 F5 F6 FF
      Parameters:
      lbl - the message to print out above the array
      bytes - the byte array to print out
      offset - the offset to start printing from the array
      length - the number of bytes to print from the array

    • debug

      public static final void debug(String lbl, Throwable t)
      Prints the specified exception with a given label if debug mode is enabled. This method calls PrintStream.println(String), and pre-pends the String ">>" to the message, so that if a program were to call (when debug mode was enabled): 
           com.dalsemi.onewire.debug.Debug.debug("Some notification...", exception);
      the resulting output would look like: 
           >> my label
     >> OneWireIOException: Device Not Present
      Parameters:
      lbl - the message to print out above the array
      t -

    • stackTrace

      public static final void stackTrace()
      Prints out an exception stack trace for debugging purposes. This is useful to figure out which functions are calling a particular function at runtime.