Module jamal.api

Interface Identified

  • All Known Subinterfaces:
    ScriptMacro, UserDefinedMacro

    public interface Identified
    Something that is usually defined by the user and as such has an identifier.

    The typical user defined things are

    • user defined macros
    • user defined scripts
    Some macros also want to implement something similar things that may or may not be accessed from the processed jamal text, but are available and managed by the code. A good example is how the macro javax0.jamal.builtins.Options is implemented. When the options is first defined it creates an instance of javax0.jamal.tools.OptionsStore, which is neither a script, nor a macro and it cannot be evaluated, but it has an identifier, which is `options. This object is stored along with the scripts and user defined macros with the same life cycle as those. If an option was set in a local environment it will no affect environments above unless it is exported.
    • Method Detail

      • getId

        java.lang.String getId()