Interface Wurbler

All Known Implementing Classes:
AbstractWurbler, ConsoleWurbler, SourceWurbler
public interface Wurbler
The wurblet container.

  • Field Details

    • WURBLET_PROPERTIES_EXTENSION

      static final String WURBLET_PROPERTIES_EXTENSION
      File extension for the wurblet property file going with a source file.
      See Also:

    • PROPSPACE_ENV

      static final String PROPSPACE_ENV
      Namespace for the runtime environment.
      See Also:

    • PROPSPACE_WURBLET

      static final String PROPSPACE_WURBLET
      Namespace for the wurblet.
      See Also:

    • PROPSPACE_EXTRA

      static final String PROPSPACE_EXTRA
      Extra namespace.
      Used for the wurbletProperties in maven poms and the properties of an ant project.
      See Also:

    • WURBLET_FILENAME

      static final String WURBLET_FILENAME
      property in wurblet namespace holding the absolute pathname of the source file.
      See Also:

    • WURBLET_FILECONTENTS

      static final String WURBLET_FILECONTENTS
      property in wurblet namespace holding the contents of the source file.
      See Also:

    • WURBLET_WURBNAME

      static final String WURBLET_WURBNAME
      property in wurblet namespace holding the pathname of the *.wurb-file (additional properties), null if none.
      See Also:

    • WURBLET_DIRNAME

      static final String WURBLET_DIRNAME
      property in wurblet namespace holding the directory of the source file.
      See Also:

    • WURBLET_GUARDNAME

      static final String WURBLET_GUARDNAME
      property in wurblet namespace holding the guardname of the wurblet anchor. (wurblet tag)
      See Also:

    • WURBLET_WURBLETNAME

      static final String WURBLET_WURBLETNAME
      property in wurblet namespace holding the name of the wurblet.
      See Also:

  • Method Details

    • wurbel

      WurbelResult wurbel() throws WurbelException, SourceException
      Processes the source file, create here-docs, and replace wurblet-guarded sections.
      Returns:
      the wurbel result
      Throws:
      WurbelException - if a file- or heapfile operation failed
      SourceException - if source scanning failed

    • getSource

      String[] getSource()
      Gets the fixed source texts.
      Returns:
      the source array

    • getPrintStream

      PrintStream getPrintStream()
      Gets the writer where to write generated code to.
      Returns:
      the open writer

    • getArgs

      String[] getArgs()
      Gets the wurblet args.
      Returns:
      array of strings representing args for the wurblet

    • getInvocationCount

      int getInvocationCount()
      Gets the invocation count.
      Wurblets are invoked as long as the data changes. Some wurblets need to know how often (e.g. to allocate HeapFiles only once).
      Returns:
      the invocation count, starting at 1

    • getProperty

      String getProperty(String nameSpace, String key)
      Gets the property value for a given namespace and key.
      Parameters:
      nameSpace - the namespace, null for the default java runtime properties
      key - the property's key
      Returns:
      the property's value, null if no such property

    • getProperties

      Properties getProperties(String nameSpace)
      Gets all Properties within a namespace.
      Parameters:
      nameSpace - the namespace, null for the default java runtime properties
      Returns:
      the properties, null if no such namespace

    • getAnalyzeFile

      File getAnalyzeFile(String name)
      Gets an analyze-information file.
      Some wurblets need extra information which is provided in files in the so-called analyze-directory (Maven parameter analyzeDir, Ant attribute analyzedir).
      Parameters:
      name - the filename relative to the analyze-directory
      Returns:
      the file

    • getVerbosity

      Verbosity getVerbosity()
      Gets the verbosity level.
      Returns:
      the verbosity

    • getLogger

      Logger getLogger()
      Gets the logger.
      Returns:
      the logger