Package org.apache.creadur.whisker.app

Class Whisker

java.lang.Object
org.apache.creadur.whisker.app.Whisker
public class Whisker extends Object
High level application, configured as a bean.

  • Constructor Details

    • Whisker

      public Whisker()

  • Method Details

    • getLicenseConfiguration

      public LicenseConfiguration getLicenseConfiguration()
      Gets the configuration options for license rendering.
      Returns:
      not null

    • setLicenseConfiguration

      public Whisker setLicenseConfiguration(LicenseConfiguration licenseConfiguration)
      Sets the configuration options for license rendering.
      Parameters:
      licenseConfiguration - not null
      Returns:
      this, not null

    • getWriterFactory

      public final ResultWriterFactory getWriterFactory()
      Gets the factory that builds product Writers.
      Returns:
      factory

    • setWriterFactory

      public final Whisker setWriterFactory(ResultWriterFactory writerFactory)
      Sets the factory that builds product Writers.
      Parameters:
      writerFactory - not null
      Returns:
      this, not null

    • getEngine

      public final AbstractEngine getEngine()
      Gets the reporting engine.
      Returns:
      not null

    • setEngine

      public final Whisker setEngine(AbstractEngine engine)
      Sets the reporting engine.
      Parameters:
      engine - not null
      Returns:
      this, not null

    • getSource

      public final String getSource()
      Gets the source on which the operation will be performed.
      Returns:
      the base, not null

    • setSource

      public final Whisker setSource(String source)
      Sets the source
      Parameters:
      source - the base to set
      Returns:
      this, not null

    • getLicenseDescriptor

      public final StreamableResource getLicenseDescriptor()
      Returns:
      the licenseDescriptor

    • setLicenseDescriptor

      public final Whisker setLicenseDescriptor(StreamableResource licenseDescriptor)
      Sets meta-data describing the source licensing.
      Parameters:
      licenseDescriptor - the licenseDescriptor to set
      Returns:
      this, not null

    • getAct

      public final Act getAct()
      Gets the operation to be performed.
      Returns:
      the act

    • setAct

      public final Whisker setAct(Act act)
      Sets the operation to be performed.
      Parameters:
      act - the act to set
      Returns:
      this, not null

    • act

      public Whisker act() throws Exception
      Performs the operation set.
      Returns:
      this, not null
      Throws:
      Exception - when the operation fails

    • configuration

      public Configuration configuration()
      Builds a populated configuration.
      Returns:
      not null

    • toString

      public String toString()
      Describes the state suitable for logging.
      Overrides:
      toString in class Object
      Returns:
      something suitable for logging