Package com.uc4.api

Class TraceOptions.TraceFlag

  • Enclosing class:
    TraceOptions
    public static class TraceOptions.TraceFlag
extends java.lang.Object
    Class used to represent a AE trace flag.

    • Constructor Summary

      Constructors 
      Constructor Description
      TraceFlag​(int idx, int val, java.lang.String txt, java.lang.String des)
      Constructs a AE Traceflag with the passed attributes.
      TraceFlag​(int idx, int val, java.lang.String txt, java.lang.String des, int min, int max)
      Constructs a AE Traceflag with the passed attributes.
      TraceFlag​(org.w3c.dom.Element traceFlag, int idx)
      Constructs a AE Traceflag from the given Element.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getDescription()
      get the trace flag description
      java.lang.String getDescriptionForTraceFlagValue​(int traceFlagValue)
      Fetches the description for the given traceflag value.
      int getIndex()
      get the trace flag index
      int getMaximum()
      Returns the maximum allowed traceflag value for this trace flag.
      int getMinimum()
      Returns the minimum allowed traceflag value for this trace flag.
      java.lang.String getText()
      get the trace flag text information
      int getValue()
      Gets the trace flag value.
      int hashCode()  
      void setValue​(int val)
      Set the trace flag value.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TraceFlag

        public TraceFlag​(int idx,
                 int val,
                 java.lang.String txt,
                 java.lang.String des)
        Constructs a AE Traceflag with the passed attributes. Minimum traceflag value will be set to 0 and maximum traceflag value to 9.
        Parameters:
        idx - the index of this trace flag. Number between 0 and 15 (inclusive).
        val - the current traceflag value. Number between 0 and 9 (inclusive).
        txt - the general description of this traceflag.
        des - the description of the traceflag values for this traceflag.

      • TraceFlag

        public TraceFlag​(int idx,
                 int val,
                 java.lang.String txt,
                 java.lang.String des,
                 int min,
                 int max)
        Constructs a AE Traceflag with the passed attributes.
        Parameters:
        idx - the index of this trace flag. Number between 0 and 15 (inclusive).
        val - the current traceflag value. Number between 0 and 9 (inclusive).
        txt - the general description of this traceflag.
        des - the description of the traceflag values supported by this traceflag.
        min - the minimum allowed traceflag value. Number between 0 and 9 (inclusive). Number lower than the max parameter.
        max - the maximum allowed traceflag value. Number between 0 and 9 (inclusive). Number greater than the min parameter.

      • TraceFlag

        public TraceFlag​(org.w3c.dom.Element traceFlag,
                 int idx)
        Constructs a AE Traceflag from the given Element.
        Parameters:
        traceFlag - Element containing the definition for this traceflag.
        idx - the index of this trace flag. Number between 0 and 15 (inclusive).

    • Method Detail

      • getIndex

        public int getIndex()
        get the trace flag index
        Returns:
        int

      • setValue

        public void setValue​(int val)
        Set the trace flag value.
        Parameters:
        val - Level between 0 and 9

      • getValue

        public int getValue()
        Gets the trace flag value.
        Returns:
        Trace level

      • getText

        public java.lang.String getText()
        get the trace flag text information
        Returns:
        String

      • getDescription

        public java.lang.String getDescription()
        get the trace flag description
        Returns:
        String

      • getMinimum

        public int getMinimum()
        Returns the minimum allowed traceflag value for this trace flag.
        Returns:
        number between 0 and 9.

      • getMaximum

        public int getMaximum()
        Returns the maximum allowed traceflag value for this trace flag.
        Returns:
        a number between 0 and 9.

      • getDescriptionForTraceFlagValue

        public java.lang.String getDescriptionForTraceFlagValue​(int traceFlagValue)
        Fetches the description for the given traceflag value.
        Parameters:
        traceFlagValue - number between 0 and 9 (inclusive).
        Returns:
        the description or the traceflag value itself if no description available.

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object