Class Trace


  • public final class Trace
    extends java.lang.Object
    This class represents a trace module.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int COMMAND
      The trace module id for commands.
      static int CONSTRAINT
      The trace module id for constraints.
      static int DATABASE
      The trace module id for databases.
      static int FILE_LOCK
      The trace module id for file locks.
      static int FUNCTION
      The trace module id for functions.
      static int INDEX
      The trace module id for indexes.
      static int JDBC
      The trace module id for the JDBC API.
      static int JDBCX
      The trace module id for the JDBCX API
      private java.lang.String lineSeparator  
      static int LOCK
      The trace module id for locks.
      private java.lang.String module  
      static java.lang.String[] MODULE_NAMES
      Module names by their ids as array indexes.
      static int SCHEMA
      The trace module id for schemas.
      static int SEQUENCE
      The trace module id for sequences.
      static int SETTING
      The trace module id for settings.
      static int TABLE
      The trace module id for tables.
      private int traceLevel  
      private TraceWriter traceWriter  
      static int TRIGGER
      The trace module id for triggers.
      static int USER
      The trace module id for users.
    • Constructor Summary

      Constructors 
      Constructor Description
      Trace​(TraceWriter traceWriter, int moduleId)  
      Trace​(TraceWriter traceWriter, java.lang.String module)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void debug​(java.lang.String s)
      Write a message with trace level DEBUG to the trace system.
      void debug​(java.lang.String s, java.lang.Object... params)
      Write a message with trace level DEBUG to the trace system.
      void debug​(java.lang.Throwable t, java.lang.String s)
      Write a message with trace level DEBUG to the trace system.
      (package private) void debugCode​(java.lang.String java)
      Write Java source code with trace level DEBUG to the trace system.
      void error​(java.lang.Throwable t, java.lang.String s)
      Write a message with trace level ERROR to the trace system.
      void error​(java.lang.Throwable t, java.lang.String s, java.lang.Object... params)
      Write a message with trace level ERROR to the trace system.
      static java.lang.String formatParams​(java.util.ArrayList<? extends ParameterInterface> parameters)
      Format the parameter list.
      void info​(java.lang.String s)
      Write a message with trace level INFO to the trace system.
      void info​(java.lang.String s, java.lang.Object... params)
      Write a message with trace level INFO to the trace system.
      (package private) void info​(java.lang.Throwable t, java.lang.String s)
      Write a message with trace level INFO to the trace system.
      void infoCode​(java.lang.String java)
      Write Java source code with trace level INFO to the trace system.
      void infoSQL​(java.lang.String sql, java.lang.String params, long count, long time)
      Write a SQL statement with trace level INFO to the trace system.
      boolean isDebugEnabled()
      Check if the trace level is equal or higher than DEBUG.
      private boolean isEnabled​(int level)  
      boolean isInfoEnabled()
      Check if the trace level is equal or higher than INFO.
      void setLevel​(int level)
      Set the trace level of this component.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • COMMAND

        public static final int COMMAND
        The trace module id for commands.
        See Also:
        Constant Field Values
      • CONSTRAINT

        public static final int CONSTRAINT
        The trace module id for constraints.
        See Also:
        Constant Field Values
      • DATABASE

        public static final int DATABASE
        The trace module id for databases.
        See Also:
        Constant Field Values
      • FUNCTION

        public static final int FUNCTION
        The trace module id for functions.
        See Also:
        Constant Field Values
      • FILE_LOCK

        public static final int FILE_LOCK
        The trace module id for file locks.
        See Also:
        Constant Field Values
      • JDBC

        public static final int JDBC
        The trace module id for the JDBC API.
        See Also:
        Constant Field Values
      • SCHEMA

        public static final int SCHEMA
        The trace module id for schemas.
        See Also:
        Constant Field Values
      • SEQUENCE

        public static final int SEQUENCE
        The trace module id for sequences.
        See Also:
        Constant Field Values
      • SETTING

        public static final int SETTING
        The trace module id for settings.
        See Also:
        Constant Field Values
      • TRIGGER

        public static final int TRIGGER
        The trace module id for triggers.
        See Also:
        Constant Field Values
      • JDBCX

        public static final int JDBCX
        The trace module id for the JDBCX API
        See Also:
        Constant Field Values
      • MODULE_NAMES

        public static final java.lang.String[] MODULE_NAMES
        Module names by their ids as array indexes.
      • module

        private final java.lang.String module
      • lineSeparator

        private final java.lang.String lineSeparator
      • traceLevel

        private int traceLevel
    • Constructor Detail

      • Trace

        Trace​(TraceWriter traceWriter,
              int moduleId)
      • Trace

        Trace​(TraceWriter traceWriter,
              java.lang.String module)
    • Method Detail

      • setLevel

        public void setLevel​(int level)
        Set the trace level of this component. This setting overrides the parent trace level.
        Parameters:
        level - the new level
      • isEnabled

        private boolean isEnabled​(int level)
      • isInfoEnabled

        public boolean isInfoEnabled()
        Check if the trace level is equal or higher than INFO.
        Returns:
        true if it is
      • isDebugEnabled

        public boolean isDebugEnabled()
        Check if the trace level is equal or higher than DEBUG.
        Returns:
        true if it is
      • error

        public void error​(java.lang.Throwable t,
                          java.lang.String s)
        Write a message with trace level ERROR to the trace system.
        Parameters:
        t - the exception
        s - the message
      • error

        public void error​(java.lang.Throwable t,
                          java.lang.String s,
                          java.lang.Object... params)
        Write a message with trace level ERROR to the trace system.
        Parameters:
        t - the exception
        s - the message
        params - the parameters
      • info

        public void info​(java.lang.String s)
        Write a message with trace level INFO to the trace system.
        Parameters:
        s - the message
      • info

        public void info​(java.lang.String s,
                         java.lang.Object... params)
        Write a message with trace level INFO to the trace system.
        Parameters:
        s - the message
        params - the parameters
      • info

        void info​(java.lang.Throwable t,
                  java.lang.String s)
        Write a message with trace level INFO to the trace system.
        Parameters:
        t - the exception
        s - the message
      • formatParams

        public static java.lang.String formatParams​(java.util.ArrayList<? extends ParameterInterface> parameters)
        Format the parameter list.
        Parameters:
        parameters - the parameter list
        Returns:
        the formatted text
      • infoSQL

        public void infoSQL​(java.lang.String sql,
                            java.lang.String params,
                            long count,
                            long time)
        Write a SQL statement with trace level INFO to the trace system.
        Parameters:
        sql - the SQL statement
        params - the parameters used, in the for {1:...}
        count - the update count
        time - the time it took to run the statement in ms
      • debug

        public void debug​(java.lang.String s,
                          java.lang.Object... params)
        Write a message with trace level DEBUG to the trace system.
        Parameters:
        s - the message
        params - the parameters
      • debug

        public void debug​(java.lang.String s)
        Write a message with trace level DEBUG to the trace system.
        Parameters:
        s - the message
      • debug

        public void debug​(java.lang.Throwable t,
                          java.lang.String s)
        Write a message with trace level DEBUG to the trace system.
        Parameters:
        t - the exception
        s - the message
      • infoCode

        public void infoCode​(java.lang.String java)
        Write Java source code with trace level INFO to the trace system.
        Parameters:
        java - the source code
      • debugCode

        void debugCode​(java.lang.String java)
        Write Java source code with trace level DEBUG to the trace system.
        Parameters:
        java - the source code