com.filenet.api.constants

Class TraceFlag

  • java.lang.Object
    • com.filenet.api.constants.TraceFlag
  • All Implemented Interfaces:
    java.io.Serializable


    public final class TraceFlag
    extends java.lang.Object
    implements java.io.Serializable
    Contains the trace logging settings used to configure trace logging (in TraceLoggingConfiguration) for the supported subsystems. Multiple trace flags can be ORed when configuring the subsystems.
    See Also:
    TraceLoggingConfiguration, Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static TraceFlag DETAIL
      Provides information primarily used to aid in debugging.
      static int DETAIL_AS_INT
      An int value associated with the DETAIL instance of this class.
      static TraceFlag MODERATE
      Provides detailed information about all operations.
      static int MODERATE_AS_INT
      An int value associated with the MODERATE instance of this class.
      static TraceFlag SUMMARY
      Provides summary information about all operations.
      static int SUMMARY_AS_INT
      An int value associated with the SUMMARY instance of this class.
      static TraceFlag TIMER
      Provides the time (in milliseconds) taken to complete each operation.
      static int TIMER_AS_INT
      An int value associated with the TIMER instance of this class.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static TraceFlag getInstanceFromInt(int value)
      Returns an instance of this class using its associated integer value.
      int getValue()
      Returns the internal integer value associated with a specific instance of this class.
      java.lang.String toString()
      Returns a String representation of this enumeration instance.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • SUMMARY_AS_INT

        public static final int SUMMARY_AS_INT
        An int value associated with the SUMMARY instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • SUMMARY

        public static final TraceFlag SUMMARY
        Provides summary information about all operations.
      • DETAIL_AS_INT

        public static final int DETAIL_AS_INT
        An int value associated with the DETAIL instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • DETAIL

        public static final TraceFlag DETAIL
        Provides information primarily used to aid in debugging.
      • MODERATE_AS_INT

        public static final int MODERATE_AS_INT
        An int value associated with the MODERATE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • MODERATE

        public static final TraceFlag MODERATE
        Provides detailed information about all operations.
      • TIMER_AS_INT

        public static final int TIMER_AS_INT
        An int value associated with the TIMER instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.
        See Also:
        Constant Field Values
      • TIMER

        public static final TraceFlag TIMER
        Provides the time (in milliseconds) taken to complete each operation.
    • Method Detail

      • getValue

        public int getValue()
        Returns the internal integer value associated with a specific instance of this class.
        Returns:
        The enumeration instance's ordinal value.
        See Also:
        getInstanceFromInt(int)
      • toString

        public java.lang.String toString()
        Returns a String representation of this enumeration instance.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The enumeration instance's description.
      • getInstanceFromInt

        public static TraceFlag getInstanceFromInt(int value)
        Returns an instance of this class using its associated integer value.
        Parameters:
        value - The integer value. (See the *_AS_INT fields.)
        Returns:
        The enumeration instance with the given ordinal value.
        Throws:
        EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
        See Also:
        getValue()

© Copyright IBM Corporation 2006, 2015. All rights reserved.