IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.pluglets.host
Interface IPlugletHost

All Known Implementing Classes:
PlugletHost

public interface IPlugletHost

This interface must be implemented by pluglet hosts that instantiate the PlugletExecutor class. Pluglet hosts can use the default PlugletHost class implementation or provide their own implementation.


Method Summary
 boolean enableTracing()
          Used by the pluglet engine to determine whether the host has tracing enabled.
 IPlugletCompiler getCompiler()
          Used by the pluglet engine to retrieve the optional compiler invocation interface.
 URLClassLoader[] getContext()
          Used by the pluglet engine to retrieve the URLClassLoader objects.
 IPlugletMessageDialog getDialog()
          Used by the pluglet engine to retrieve the IPlugletMessageDialog implementation.
 PrintWriter getOutput()
          Used by the pluglet engine to retrieve the stream used for the pluglet output, the pluglet engine's tracing output, and the compiler error messages.
 

Method Detail

getCompiler

public IPlugletCompiler getCompiler()
Used by the pluglet engine to retrieve the optional compiler invocation interface.

You can use the PlugletCompiler class to construct a compiler or you can construct your own implementation of the IPlugletCompiler interface.

Returns:
Returns the implementation of the host's pluglet compiler interface.

getContext

public URLClassLoader[] getContext()
Used by the pluglet engine to retrieve the URLClassLoader objects.

The URLClassLoader objects define what classes are visible to the pluglets that are executed from this host.

Returns:
Returns the host class loaders that the pluglets access.

getDialog

public IPlugletMessageDialog getDialog()
Used by the pluglet engine to retrieve the IPlugletMessageDialog implementation.

This method is used by the Pluglet class to implement dialog methods.

Returns:
Returns the IPlugletMessageDialog implementation of the host.

getOutput

public PrintWriter getOutput()
Used by the pluglet engine to retrieve the stream used for the pluglet output, the pluglet engine's tracing output, and the compiler error messages.

Because the pluglet engine assigns the value returned by this method to the Pluglet.out class variable, the output of the pluglet is displayed to this output stream.

If tracing is enabled, the PlugletExecutor tracing output is also displayed to this stream. Depending on the implementation of the IPlugletCompiler interface, all compiler error messages are displayed to this stream.

Returns:
The host's PrintWriter for pluglet output.

enableTracing

public boolean enableTracing()
Used by the pluglet engine to determine whether the host has tracing enabled.

The PlugletExecutor tracing is enabled if this returns a boolean value of true.

Returns:
Returns a boolean that has a value of true when tracing is enabled. Otherwise, it returns a value of false.

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.