oracle.ide.extension
Class PropertiesExtensionProcessorPlugin

java.lang.Object
  oracle.ide.extension.ExtensionProcessorPlugin
      oracle.ide.extension.PropertiesExtensionProcessorPlugin

public class PropertiesExtensionProcessorPlugin
extends ExtensionProcessorPlugin

An ExtensionProcessorPlugin based on a properties file. Property values which appear to be file URLs--which start with "file:"--are resolved relative to the property file.

Constructor Summary

PropertiesExtensionProcessorPlugin(java.io.File file)

Method Summary

java.lang.String	expandValue(ExtensionProcessorContext context, java.lang.String macroName) Expands a macro encountered while processing an extension manifest.
java.util.Set<java.lang.String>	getSupportedMacros(ExtensionProcessorContext context) Returns a Set of macro names which are supported in the specified extension processing context.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PropertiesExtensionProcessorPlugin

public PropertiesExtensionProcessorPlugin(java.io.File file)

Method Detail

getSupportedMacros

public java.util.Set<java.lang.String> getSupportedMacros(ExtensionProcessorContext context)

Description copied from class: ExtensionProcessorPlugin

Returns a Set of macro names which are supported in the specified extension processing context.

Extension manifests can contain macro usages in any attribute value or text node. The syntax of a macro usage is

${macroname}

.

An ExtensionProcessorPlugin may provide logic to expand macros in the extension manifest. The plugin should return a collection of supported macro names from this method.

While processing manifest files, the ExtensionProcessorPlugin.expandValue(ExtensionProcessorContext,String) method will be called for each occurrence of macros supported by this plugin.

Macro names ending with a colon (:) are macro namespaces. These can be used to implement dynamic macros, such as sysprop:some.property.

This implementation returns an empty set. Will never be null.

Overrides:

getSupportedMacros in class ExtensionProcessorPlugin

Parameters:

context - the extension processing context.

Returns:

a set of supported macro names.

expandValue

public java.lang.String expandValue(ExtensionProcessorContext context,
                                    java.lang.String macroName)

Description copied from class: ExtensionProcessorPlugin

Expands a macro encountered while processing an extension manifest.

You should take care to optimize the performance of this method, since it will be called every time a macro encountered in the extension manifest needs to be expanded.

This implementation returns null.

Overrides:

expandValue in class ExtensionProcessorPlugin

Parameters:

context - the extension processing context. Will never be null.

macroName - the name of the macro to expand.

Returns:

the expanded value of the macro. If you return null from this method, the macro will not be expanded (the original macro string will be retained intact).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object