Class TraceSpace


  • public abstract class TraceSpace
    extends java.lang.Object
    A TraceSpace.
    Author:
    IIT GmbH, Bremen/Germany, Copyright (c) 2000-2002, All Rights Reserved
    • Field Summary

      Fields 
      Modifier and Type Field Description
      boolean enabled
      States whether the space is enabled or not.
    • Constructor Summary

      Constructors 
      Constructor Description
      TraceSpace​(java.lang.String spaceName, boolean enabled)
      Creates a new trace space
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Closes the space.
      protected abstract void closeSpaceResources()
      Abstract method which is called during close to close any resources associates with this space (i.
      java.lang.String getSpaceName()
      Returns the space name
      abstract void trace​(java.lang.String subEntity, java.lang.String message)
      Trace a message to the space.
      • Methods inherited from class java.lang.Object

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

      • enabled

        public boolean enabled
        States whether the space is enabled or not. Swiftlets are checking this flag before calling the trace() method to avoid unnecessary calls and String operations.
    • Constructor Detail

      • TraceSpace

        public TraceSpace​(java.lang.String spaceName,
                          boolean enabled)
        Creates a new trace space
        Parameters:
        spaceName - space name
        enabled - enabled or not
    • Method Detail

      • getSpaceName

        public java.lang.String getSpaceName()
        Returns the space name
        Returns:
        space name
      • trace

        public abstract void trace​(java.lang.String subEntity,
                                   java.lang.String message)
        Trace a message to the space. The subEntity parameter specifies what kind of entity is tracing. A Extension Swiftlet would use the Swiftlet name here.
        Parameters:
        subEntity - sub entity
        message - trace message
      • closeSpaceResources

        protected abstract void closeSpaceResources()
        Abstract method which is called during close to close any resources associates with this space (i. e. output streams).
      • close

        public void close()
        Closes the space. After that the space is unusable.