Klasse GroovyOutlet

Alle implementierten Schnittstellen:
Outlet, TemplateOutlet
Bekannte direkte Unterklassen:
GroovyScriptOutlet, GroovyTemplateOutlet

public abstract class GroovyOutlet extends TemplateOutletImpl
A Outlet which uses groovy for generation.
  • Felddetails

    • TORQUE_GEN_BINDING_NAME

      public static final String TORQUE_GEN_BINDING_NAME
      The name under which the Torque generator interface will be put into the binding.
      Siehe auch:
    • NULL_KEY_BINDING_NAME

      public static final String NULL_KEY_BINDING_NAME
      The key under which the null attribute of a source element is put into the binding.
      Siehe auch:
  • Konstruktordetails

    • GroovyOutlet

      public GroovyOutlet(QualifiedName name, ConfigurationProvider configurationProvider, String path, String encoding) throws ConfigurationException
      Constructs a new GroovyOutlet.
      Parameter:
      name - the name of this outlet, not null.
      configurationProvider - the provider for reading the templates, not null.
      path - the path to the templates, not null.
      encoding - the encoding of the file, or null if the system's default encoding should be used.
      Löst aus:
      NullPointerException - if name, path or directories are null.
      ConfigurationException - if an error occurs while reading the template.
  • Methodendetails

    • execute

      public OutletResult execute(ControllerState controllerState) throws GeneratorException
      Executes the generation process; the result is returned.
      Angegeben von:
      execute in Schnittstelle Outlet
      Angegeben von:
      execute in Klasse OutletImpl
      Parameter:
      controllerState - the current controller state.
      Gibt zurück:
      the result of the generation, not null.
      Löst aus:
      GeneratorException - if generation fails.
      Siehe auch:
    • executeGroovy

      protected abstract String executeGroovy(Map<String,Object> binding, ControllerState controllerState) throws GeneratorException
      Executes the Groovy script or template and retuns the reult.
      Parameter:
      binding - the binding, not null.
      controllerState - the controller state, not null.
      Gibt zurück:
      the generation result.
      Löst aus:
      GeneratorException - if generation fails.
    • createBinding

      public Map<String,Object> createBinding(ControllerState controllerState)
    • setOptionsInBinding

      public void setOptionsInBinding(boolean optionsInBinding)
      Tells the outlet to put all options which name space is visible to the namespace of this outlet into the binding. Only the variable names are used as keys in the context, the namespaces are stripped.
      Parameter:
      optionsInBinding - whether to put the options into the context.
    • isOptionsInBinding

      public boolean isOptionsInBinding()
      Returns whether all options which namespaces are visible to the name space of this outlet are put into the binding.
      Gibt zurück:
      whether the outlet puts the options into the context.
    • setVariablesInContext

      public void setVariablesInContext(boolean variablesInBinding)
      Tells the outlet to put all variables which are visible to this outlet into the binding. Only the variable names are used as keys in the binding, the namespaces are stripped.
      Parameter:
      variablesInBinding - whether to put the variables into the context.
    • isVariablesInBinding

      public boolean isVariablesInBinding()
      Returns whether all variables which are visible to this outlet are put into the binding.
      Gibt zurück:
      whether the outlet puts the variables into the binding.
    • setSourceAttributesInBinding

      public void setSourceAttributesInBinding(boolean sourceAttributesInBinding)
      Tells the outlet to put the attributes of the current source element into the binding or not.
      Parameter:
      sourceAttributesInBinding - whether to put the source attributes into the binding.
    • isSourceAttributesInBinding

      public boolean isSourceAttributesInBinding()
      Returns whether the attributes of the current source element are put into the binding.
      Gibt zurück:
      whether the outlet puts the attributes of the current source element into the binding.