oracle.ide.extension.macros

Interface ExtensionMacro

All Known Implementing Classes:

ExtensionMacroByExactMatch, ExtensionMacroByPrefix

public interface ExtensionMacro

An interface for macros to be used in extension.xml.

This interface works in conjunction with extension-macro-definition-hook. Implementors must have an empty constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canExpandMacro(java.lang.String unexpandedMacro, ElementContext elementContext) Answers whether this unexpanded macro may be handled by this extension macro.
java.lang.String	expandMacro(java.lang.String unexpandedMacro, ElementContext elementContext) Given an unexpanded macro, expand it and return the expanded string.

Method Detail

expandMacro

java.lang.String expandMacro(java.lang.String unexpandedMacro,
                           ElementContext elementContext)

Given an unexpanded macro, expand it and return the expanded string.

Parameters:

unexpandedMacro - unexpanded macro

elementContext - the extension traversal element context

Returns:

the expanded value of the macro

canExpandMacro

boolean canExpandMacro(java.lang.String unexpandedMacro,
                     ElementContext elementContext)

Answers whether this unexpanded macro may be handled by this extension macro. If this method returns true then ExtensionMacro#expandMacro(String) will be called.

Parameters:

unexpandedMacro - the unexpanded macro

elementContext - the extension traversal element context

Returns:

whether this extension macro can expand