de.intarsys.claptz.impl

Class StandardInstrument.Facade

java.lang.Object

de.intarsys.claptz.impl.StandardInstrument.Facade

All Implemented Interfaces:

IInstrument, IAttributeSupport, IMetaInfoSupport, IFileEnvironment, IMessageBundleSupport, IClassLoaderSupport

Enclosing class:

StandardInstrument

public class StandardInstrument.Facade
extends Object
implements IInstrument

The "public" portion of the Instrument implementation, which itself is never leaked to client code.

Field Summary

Fields inherited from interface de.intarsys.tools.component.IMetaInfoSupport

META_ID, META_NAME, META_VENDOR, META_VERSION

Constructor Summary

Constructors

Constructor and Description
StandardInstrument.Facade()

Method Summary

Methods

Modifier and Type	Method and Description
void	addPrerequisite(IInstrument prerequisite, String absentAction)
IExtension	createExtension(String extensionPointId, String id)
void	flush()
Object	getAttribute(Object key) Get an attribute value from the context
File	getBaseDir() The platform base directory.
ClassLoader	getClassLoader() A ClassLoader instance suitable to load classes and resources in the context of the receiver.
IExtension[]	getExtensions() The extensions made by this IExtensionProvider.
String	getId() A unique name for the instrument.
IInstrumentRegistry	getInstrumentRegistry() The IInstrumentRegistry where this IInstrument is currently registered.
MessageBundle	getMessageBundle() A MessageBundle instance suitable to load messages associated with the receiver context.
String	getMetaInfo(String name)
IInstrumentPrerequisite[]	getPrerequisites() The collection of IInstrumentPrerequisite objects that are required to be available for this one to run.
File	getProfileDir() Some user specific private directory.
State	getState()
File	getTempDir() The directory for temporary files.
File	getWorkingDir() The working directory.
void	registerExtension(IExtension extension) Add extension to the IExtension instances managed by this IExtensionProvider
Object	removeAttribute(Object key) Remove an attribute binding in the context
void	removePrerequisite(IInstrument prerequisite)
Object	setAttribute(Object key, Object o) Set the value of an attribute in the context
String	toString()
void	unregisterExtension(IExtension extension) Remove extension from the IExtension instances managed by this IExtensionProvider

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StandardInstrument.Facade

public StandardInstrument.Facade()

Method Detail

addPrerequisite

public void addPrerequisite(IInstrument prerequisite,
                   String absentAction)

Specified by:

addPrerequisite in interface IInstrument

createExtension

public IExtension createExtension(String extensionPointId,
                         String id)

Specified by:

createExtension in interface IInstrument

flush

public void flush()
           throws IOException

Specified by:

flush in interface IInstrument

Throws:

IOException

getAttribute

public final Object getAttribute(Object key)

Description copied from interface: IAttributeSupport

Get an attribute value from the context

Specified by:

getAttribute in interface IAttributeSupport

Parameters:

key - the name of the attribute to get

Returns:

The value of the attribute key

getBaseDir

public File getBaseDir()

Description copied from interface: IFileEnvironment

The platform base directory.

Normally this will be equal to the VM "user.dir" property.

Specified by:

getBaseDir in interface IFileEnvironment

Returns:

The platform base directory.

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: IClassLoaderSupport

A ClassLoader instance suitable to load classes and resources in the context of the receiver.

Specified by:

getClassLoader in interface IClassLoaderSupport

Returns:

A ClassLoader instance suitable to load classes and resources in the context of the receiver.

getExtensions

public IExtension[] getExtensions()

Description copied from interface: IInstrument

The extensions made by this IExtensionProvider.

Specified by:

getExtensions in interface IInstrument

Returns:

The extensions made by this IExtensionProvider.

getId

public String getId()

Description copied from interface: IInstrument

A unique name for the instrument.

It is used for identifying uniquely a instrument within the IInstrumentRegistry. Clients may lookup instruments with well known names, for example the annotation handling instrument.

By convention this should conform to the standard java notation for class names.

Specified by:

getId in interface IInstrument

Returns:

A string identifying the instrument uniquely.

getInstrumentRegistry

public IInstrumentRegistry getInstrumentRegistry()

Description copied from interface: IInstrument

The IInstrumentRegistry where this IInstrument is currently registered.

Specified by:

getInstrumentRegistry in interface IInstrument

Returns:

The IInstrumentRegistry where this IInstrument is currently registered.

getMessageBundle

public MessageBundle getMessageBundle()

Description copied from interface: IMessageBundleSupport

A MessageBundle instance suitable to load messages associated with the receiver context.

Specified by:

getMessageBundle in interface IMessageBundleSupport

Returns:

A MessageBundle instance suitable to load messages associated with the receiver context.

getMetaInfo

public String getMetaInfo(String name)

Specified by:

getMetaInfo in interface IMetaInfoSupport

getPrerequisites

public IInstrumentPrerequisite[] getPrerequisites()

Description copied from interface: IInstrument

The collection of IInstrumentPrerequisite objects that are required to be available for this one to run.

Specified by:

getPrerequisites in interface IInstrument

Returns:

The collection of IInstrumentPrerequisite objects that are required to be available for this one to run.

getProfileDir

public File getProfileDir()

Description copied from interface: IFileEnvironment

Some user specific private directory.

Normally this will be equal to the VM "user.home" property or an application defined subdirectory.

Specified by:

getProfileDir in interface IFileEnvironment

Returns:

Some private directory.

getState

public State getState()

Specified by:

getState in interface IInstrument

getTempDir

public File getTempDir()

Description copied from interface: IFileEnvironment

The directory for temporary files.

Normally this will be equal to the VM "java.io.tmpdir" property.

Specified by:

getTempDir in interface IFileEnvironment

Returns:

The directory for temporary files.

getWorkingDir

public File getWorkingDir()

Description copied from interface: IFileEnvironment

The working directory.

Normally this will be equal to the VM "user.dir" property.

Specified by:

getWorkingDir in interface IFileEnvironment

Returns:

The working directory.

registerExtension

public void registerExtension(IExtension extension)
                       throws InstrumentRegistryException

Description copied from interface: IInstrument

Add extension to the IExtension instances managed by this IExtensionProvider

Specified by:

registerExtension in interface IInstrument

Throws:

InstrumentRegistryException

removeAttribute

public final Object removeAttribute(Object key)

Description copied from interface: IAttributeSupport

Remove an attribute binding in the context

Specified by:

removeAttribute in interface IAttributeSupport

Parameters:

key - the name of the attribute to remove

Returns:

The previously associated value for key

removePrerequisite

public void removePrerequisite(IInstrument prerequisite)

Specified by:

removePrerequisite in interface IInstrument

setAttribute

public final Object setAttribute(Object key,
                  Object o)

Description copied from interface: IAttributeSupport

Set the value of an attribute in the context

Specified by:

setAttribute in interface IAttributeSupport

Parameters:

key - the name of the attribute to set

o - the new value the attribute

Returns:

The previously associated value for key

toString

public String toString()

Overrides:

toString in class Object

unregisterExtension

public void unregisterExtension(IExtension extension)
                         throws InstrumentRegistryException

Description copied from interface: IInstrument

Remove extension from the IExtension instances managed by this IExtensionProvider

Specified by:

unregisterExtension in interface IInstrument

Throws:

InstrumentRegistryException