Module jamal.extensions
Package javax0.jamal.extensions

Class UDMacro

java.lang.Object
javax0.jamal.extensions.UDMacro
public class UDMacro extends Object
Utility class to fetch the value of a user defined macro. This is used to get parameter strings, for example the macro NumberLines has the following lines: 

         final var format = UDMacro.macro("format").from(processor).orElse("%d. ");
         final var start = UDMacro.macro("start").integer().from(processor).orElse(1);
         final var step = UDMacro.macro("step").integer().from(processor).orElse(1);

to fetch the string value of the macros format, start, step. When the method integer() is inserted into the call chain then the returned value is converted to integer.

  • Method Details

    • macro

      public static UDMacro macro(String id)

    • from

      public Optional<String> from(javax0.jamal.api.Processor processor) throws javax0.jamal.api.BadSyntax
      Throws:
      javax0.jamal.api.BadSyntax

    • integer

      public UDMacro.IntUDMac integer()