StandardInstrument (intarsys runtime library)

java.lang.Object
- de.intarsys.claptz.impl.StandardInstrument

All Implemented Interfaces:

IAttributeSupport, IElementConfigurable
```
public class StandardInstrument
extends Object
implements IAttributeSupport, IElementConfigurable
```
An internal representation of an IInstrument.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`class`	`StandardInstrument.Facade` The "public" portion of the Instrument implementation, which itself is never leaked to client code.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTION_DEFAULT`
`static String`	`ACTION_FAIL`
`static String`	`ACTION_IGNORE`
`static String`	`ACTION_SKIP`
`static boolean`	`CHECK_VISIBILITY`
`static String`	`META_DEFINITION`
`static String`	`META_DIRECTORY`

Constructor Summary

Constructors
Constructor and Description

StandardInstrument(StandardInstrumentRegistry registry, IInstrumentStore store)

Constructors
Constructor and Description
`StandardInstrument(StandardInstrumentRegistry registry, IInstrumentStore store)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`configure(IElement element)`
`IExtension`	`createExtension(String extensionPointId, String id)`
`Object`	`getAttribute(Object key)` Get an attribute value from the context
`File`	`getBaseDir()`
`ClassLoader`	`getClassLoader()`
`String`	`getDescription()`
`IStringEvaluator`	`getExpressionEvaluator()`
`List<StandardExtension>`	`getExtensions()`
`IInstrument`	`getFacade()`
`String`	`getId()` A unique name for the instrument.
`String`	`getIfdef()`
`String`	`getIfnotdef()`
`StandardInstrumentRegistry`	`getInstrumentRegistry()`
`MessageBundle`	`getMessageBundle()`
`String`	`getMessageBundleName()`
`String`	`getMetaInfo(String name)`
`List<StandardInstrumentPrerequisite>`	`getPrerequisites()`
`File`	`getProfileDir()`
`IInstrumentStore`	`getStore()`
`File`	`getTempDir()`
`File`	`getWorkingDir()`
`void`	`registerExtension(StandardExtension extension)`
`Object`	`removeAttribute(Object key)` Remove an attribute binding in the context
`void`	`removePrerequisite(IInstrument prerequisite)`
`Object`	`setAttribute(Object key, Object value)` Set the value of an attribute in the context
`void`	`setBaseDir(File baseDir)`
`void`	`setId(String name)`
`void`	`setIfdef(String ifdef)`
`void`	`setIfnotdef(String ifnotdef)`
`void`	`setMessageBundle(MessageBundle bundle)`
`void`	`setMessageBundleName(String bundleName)`
`void`	`setMetaInfo(String name, String value)`
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

META_DEFINITION

public static final String META_DEFINITION

See Also:: Constant Field Values

META_DIRECTORY

public static final String META_DIRECTORY

See Also:: Constant Field Values

CHECK_VISIBILITY
```
public static final boolean CHECK_VISIBILITY
```
See Also:
Constant Field Values

ACTION_DEFAULT

public static final String ACTION_DEFAULT

ACTION_FAIL
```
public static final String ACTION_FAIL
```
See Also:
Constant Field Values

ACTION_IGNORE

public static final String ACTION_IGNORE

See Also:: Constant Field Values

ACTION_SKIP
```
public static final String ACTION_SKIP
```
See Also:
Constant Field Values

Constructor Detail

StandardInstrument

public StandardInstrument(StandardInstrumentRegistry registry,
                  IInstrumentStore store)

Method Detail

configure
```
public void configure(IElement element)
               throws ConfigurationException
```
Specified by:

configure in interface IElementConfigurable

Throws:

ConfigurationException

createExtension

public IExtension createExtension(String extensionPointId,
                         String id)

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()
```

getClassLoader
```
public ClassLoader getClassLoader()
```

getDescription
```
public String getDescription()
```

getExpressionEvaluator

public IStringEvaluator getExpressionEvaluator()

getExtensions

public List<StandardExtension> getExtensions()

getFacade
```
public IInstrument getFacade()
```

getId
```
public String getId()
```
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.

Returns:
A string identifying the instrument uniquely.

getIfdef
```
public String getIfdef()
```

getIfnotdef
```
public String getIfnotdef()
```

getInstrumentRegistry

public StandardInstrumentRegistry getInstrumentRegistry()

getMessageBundle

public MessageBundle getMessageBundle()

getMessageBundleName
```
public String getMessageBundleName()
```

getMetaInfo

public String getMetaInfo(String name)

getPrerequisites

public List<StandardInstrumentPrerequisite> getPrerequisites()

getProfileDir
```
public File getProfileDir()
```

getStore
```
public IInstrumentStore getStore()
```

getTempDir
```
public File getTempDir()
```

getWorkingDir
```
public File getWorkingDir()
```

registerExtension

public void registerExtension(StandardExtension extension)
                       throws InstrumentRegistryException

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)

setAttribute
```
public final Object setAttribute(Object key,
                  Object value)
```
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
value - the new value the attribute

Returns:
The previously associated value for key

setBaseDir
```
public void setBaseDir(File baseDir)
```

setId
```
public void setId(String name)
```

setIfdef
```
public void setIfdef(String ifdef)
```

setIfnotdef

public void setIfnotdef(String ifnotdef)

setMessageBundle

public void setMessageBundle(MessageBundle bundle)

setMessageBundleName

public void setMessageBundleName(String bundleName)

setMetaInfo

public void setMetaInfo(String name,
               String value)

toString
```
public String toString()
```
Overrides:

toString in class Object

Class StandardInstrument

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

META_DEFINITION

META_DIRECTORY

CHECK_VISIBILITY

ACTION_DEFAULT

ACTION_FAIL

ACTION_IGNORE

ACTION_SKIP

Constructor Detail

StandardInstrument

Method Detail

configure

createExtension

getAttribute

getBaseDir

getClassLoader

getDescription

getExpressionEvaluator

getExtensions

getFacade

getId

getIfdef

getIfnotdef

getInstrumentRegistry

getMessageBundle

getMessageBundleName

getMetaInfo

getPrerequisites

getProfileDir

getStore

getTempDir

getWorkingDir

registerExtension

removeAttribute

removePrerequisite

setAttribute

setBaseDir

setId

setIfdef

setIfnotdef

setMessageBundle

setMessageBundleName

setMetaInfo

toString