Package com.swiftmq.swiftlet.trace

Class TraceSpace

java.lang.Object
com.swiftmq.swiftlet.trace.TraceSpace
public abstract class TraceSpace extends 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(String spaceName, boolean enabled)
    Creates a new trace space

  • Method Summary

    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.
    String
    getSpaceName()
    Returns the space name
    abstract void
    trace(String subEntity, 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 Details

    • 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 Details

    • TraceSpace

      public TraceSpace(String spaceName, boolean enabled)
      Creates a new trace space
      Parameters:
      spaceName - space name
      enabled - enabled or not

  • Method Details

    • getSpaceName

      public String getSpaceName()
      Returns the space name
      Returns:
      space name

    • trace

      public abstract void trace(String subEntity, 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.