## Uses of Class
org.apache.torque.generator.control.ControllerState

- Packages that use ControllerState
  Package | Description
  --- | ---
  org.apache.torque.generator.control | This package implements the torque generator Controller .
  org.apache.torque.generator.control.action | This package defines and implements mergepoint actions.
  org.apache.torque.generator.outlet | This package defines torque generator outlets which produce output snippets from the source.
  org.apache.torque.generator.outlet.copy | This package defines and implements copy outlets.
  org.apache.torque.generator.outlet.java | This package defines java outlets and provides some implementations.
  org.apache.torque.generator.source | This package contains the handling of source files.
  org.apache.torque.generator.source.jdbc | This package implements sources which read from jdbc.
  org.apache.torque.generator.source.skipDecider | This package contains the definition and implementations of source filters.
  org.apache.torque.generator.source.stream | This package contains the handling of stream-based sources, such as file sources.
  org.apache.torque.generator.source.transform | This package contains the definition of source transformers and some implementations.
  org.apache.torque.generator.template | This package contains the handling of template-based outlets in the Torque generator.
  org.apache.torque.generator.template.groovy | This package contains the handling of groovy outlets in the Torque generator.
  org.apache.torque.generator.template.velocity | This package contains the handling of velocity outlets in the Torque generator.

- - ### Uses of ControllerState in org.apache.torque.generator.control

    Methods in org.apache.torque.generator.control with parameters of type ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | Controller.`createOutputFilename(Output output, ControllerState controllerState)` Creates the output file name and sets it in the output.
    `protected void` | Controller.`processGenerationUnit(ControllerState controllerState, UnitConfiguration unitConfiguration)` Processes a unit of generation.
    `Object` | Controller.`transformSource(Object sourceRoot, List<SourceTransformerDefinition> transformerDefinitions, ControllerState controllerState)` Applies all transformer definitions to the current source.

    Constructors in org.apache.torque.generator.control with parameters of type ControllerState
    Constructor and Description
    `TokenReplacer(ControllerState controllerState)`

  - ### Uses of ControllerState in org.apache.torque.generator.control.action

    Methods in org.apache.torque.generator.control.action with parameters of type ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `OutletResult` | ApplyAction.`execute(ControllerState controllerState)` Applies an outlet to the matching element.
    `OutletResult` | MergepointAction.`execute(ControllerState controllerState)` Executes the action.
    `OutletResult` | OptionAction.`execute(ControllerState controllerState)` Returns the value of the configured option.
    `OutletResult` | OutputAction.`execute(ControllerState controllerState)` Returns the value.
    `OutletResult` | SourceElementAttributeAction.`execute(ControllerState controllerState)` Returns the value of the configured attribute of the configured source element.
    `OutletResult` | TraverseAllAction.`execute(ControllerState controllerState)` Traverses all matching elements, and applies an outlet to each matching element.

  - ### Uses of ControllerState in org.apache.torque.generator.outlet

    Methods in org.apache.torque.generator.outlet with parameters of type ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `void` | DebuggingOutletWrapper.`afterExecute(ControllerState controllerState)` Calls the afterExecute method in the delegate.
    `void` | Outlet.`afterExecute(ControllerState controllerState)` Adjusts the state of the Controller after generation.
    `void` | OutletImpl.`afterExecute(ControllerState controllerState)`
    `void` | DebuggingOutletWrapper.`beforeExecute(ControllerState controllerState)` Calls the beforeExecute method in the delegate.
    `void` | Outlet.`beforeExecute(ControllerState controllerState)` Adjusts the state of the Controller before generation.
    `void` | OutletImpl.`beforeExecute(ControllerState controllerState)`
    `OutletResult` | DebuggingOutletWrapper.`execute(ControllerState controllerState)` Executes the delegate generation and adds debugging output before and after the generated content, if the result is a String result.
    `OutletResult` | Outlet.`execute(ControllerState controllerState)` Generates the output for this template into the Generated object.
    `abstract OutletResult` | OutletImpl.`execute(ControllerState controllerState)`
    `protected String` | DebuggingOutletWrapper.`getCommentAtEnd(ControllerState controllerState)` Returns the debug information to be added at the end of the outlet's output.
    `protected String` | DebuggingOutletWrapper.`getCommentAtStart(ControllerState controllerState)` Returns the debug information to be added at the start of the outlet's output.
    `Object` | OutletImpl.`getVariable(String key, ControllerState controllerState)` Returns the variable with the given key.
    `String` | OutletImpl.`mergepoint(String mergepointName, ControllerState controllerState)` Processes the mergepoint with the given name.
    `void` | OutletImpl.`setVariable(String key, Object value, ControllerState controllerState)` Sets a variable.
    `void` | OutletImpl.`setVariable(String key, Object value, Variable.Scope scope, ControllerState controllerState)` Sets a variable.

  - ### Uses of ControllerState in org.apache.torque.generator.outlet.copy

    Methods in org.apache.torque.generator.outlet.copy with parameters of type ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `OutletResult` | CopyOutlet.`execute(ControllerState controllerState)` Executes the generation process; the result is returned.

  - ### Uses of ControllerState in org.apache.torque.generator.outlet.java

    Methods in org.apache.torque.generator.outlet.java with parameters of type ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `OutletResult` | CamelbackOutlet.`execute(ControllerState controllerState)` Processes the input according to the camelback rules.
    `OutletResult` | ConstantNameOutlet.`execute(ControllerState controllerState)` Processes the input according to the camelback rules.
    `OutletResult` | JavadocOutlet.`execute(ControllerState controllerState)`
    `OutletResult` | JavaFilenameOutlet.`execute(ControllerState controllerState)`
    `OutletResult` | ModifySourcenameOutlet.`execute(ControllerState controllerState)`
    `OutletResult` | NewlineOutlet.`execute(ControllerState controllerState)`
    `OutletResult` | OptionOutlet.`execute(ControllerState controllerState)`
    `OutletResult` | PackageToPathOutlet.`execute(ControllerState controllerState)` Reads the input and replaces all dots by slashes.
    `OutletResult` | XmlOutlet.`execute(ControllerState controllerState)`
    `static String` | OutletUtils.`getFromDifferentPlaces(String presetValue, String optionName, String variableName, String sourceElementName, String sourceElementAttribute, ControllerState controllerState, Class<?> clazz, String expectedFieldNames)` Retrieve a value from either a preset value, an option, a variable, or a source element attribute.
    `protected String` | StringInputOutlet.`getInput(ControllerState controllerState)` Retrieves the input from the different possibilities nputValue, inputOption, inputVariable, or inputSourceElement.
    `static String` | OutletUtils.`getOption(String optionName, ControllerState controllerState, Class<?> clazz)` Reads an option with a given name.
    `static String` | OutletUtils.`getSourceElementAttribute(String elementName, String attributeName, ControllerState controllerState, Class<?> clazz)` Retrieves the value of a source element attribute.

  - ### Uses of ControllerState in org.apache.torque.generator.source

    Methods in org.apache.torque.generator.source with parameters of type ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `void` | SourceProvider.`init(ConfigurationHandlers configurationHandlers, ControllerState controllerState)` Initializes the source provider.
    `protected abstract void` | SourceProvider.`initInternal(ConfigurationHandlers configurationHandlers, ControllerState controllerState)` Initializes the sources provided by this SourceProvider.
    `void` | SourceProvider.`reset(ConfigurationHandlers configurationHandlers, ControllerState controllerState)` Resets the source provider.
    `protected abstract void` | SourceProvider.`resetInternal(ConfigurationHandlers configurationHandlers, ControllerState controllerState)` Resets the sources provided by this SourceProvider.

  - ### Uses of ControllerState in org.apache.torque.generator.source.jdbc

    Methods in org.apache.torque.generator.source.jdbc with parameters of type ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `void` | JdbcMetadataSourceProvider.`initInternal(ConfigurationHandlers configurationHandlers, ControllerState controllerState)`
    `protected void` | JdbcMetadataSourceProvider.`resetInternal(ConfigurationHandlers configurationHandlers, ControllerState controllerState)`

  - ### Uses of ControllerState in org.apache.torque.generator.source.skipDecider

    Methods in org.apache.torque.generator.source.skipDecider with parameters of type ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | SkipDecider.`proceed(ControllerState controllerState)` Decides whether the source file should be skipped and not used for generation.
    `boolean` | StopGenerationDecider.`proceed(ControllerState controllerState)` Decides whether generation should proceed.

  - ### Uses of ControllerState in org.apache.torque.generator.source.stream

    Methods in org.apache.torque.generator.source.stream with parameters of type ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | FileSourceProvider.`initInternal(ConfigurationHandlers configurationHandlers, ControllerState controllerState)` Determines the files which match the source fileset.
    `SourceElement` | PropertiesSourceFormat.`parse(InputStream inputStream, ControllerState controllerState)` Parses a Stream in Properties format and returns the root element of the created element tree.
    `SourceElement` | StreamSourceFormat.`parse(InputStream inputStream, ControllerState controllerState)` Parses a source file and returns its root element.
    `SourceElement` | XmlSourceFormat.`parse(InputStream xmlStream, ControllerState controllerState)` Parses a stream containing xml data and creates a source element hierarchy from it.
    `void` | FileSourceProvider.`resetInternal(ConfigurationHandlers configurationHandlers, ControllerState controllerState)`

    Constructors in org.apache.torque.generator.source.stream with parameters of type ControllerState
    Constructor and Description
    `FileSource(StreamSourceFormat format, File path, ControllerState controllerState)` Constructor.

  - ### Uses of ControllerState in org.apache.torque.generator.source.transform

    Methods in org.apache.torque.generator.source.transform with parameters of type ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `Object` | AttributeTransformer.`transform(Object toTransform, ControllerState controllerState)` Adds attributes to the sourceElement according to the transformDefinition.
    `SourceElement` | BeanPropertyMethodNameTransformer.`transform(Object rootObject, ControllerState controllerState)` Fills the target attribute according to the settings.
    `SourceElement` | CopyAttributeTransformer.`transform(Object rootObject, ControllerState controllerState)` Fills the target attribute according to the settings.
    `SourceElement` | GetterSetterNameTransformer.`transform(Object rootObject, ControllerState controllerState)` Fills the target attributes according to the settings.
    `SourceElement` | LoadAdditionalSourceTransformer.`transform(Object rootObject, ControllerState controllerState)` Loads the additional source into the current source graph.
    `Object` | LoadAllSourceFilesTransformer.`transform(Object rootObject, ControllerState controllerState)` Loads the additional source into the current source graph.
    `Object` | SourceElementToModelTransformer.`transform(Object modelRoot, ControllerState controllerState)`
    `abstract Object` | SourceTargetAttributeTransformer.`transform(Object toTransformRoot, ControllerState controllerState)` Performs the transformation.
    `Object` | SourceTransformer.`transform(Object modelRoot, ControllerState controllerState)` Transforms one source root into another source root.

  - ### Uses of ControllerState in org.apache.torque.generator.template

    Methods in org.apache.torque.generator.template with parameters of type ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `String` | TemplateOutlet.`getContent(ControllerState controllerState)` Returns the contents as a Template as a String.
    `String` | TemplateOutletImpl.`getContent(ControllerState controllerState)`
    `protected String` | TemplateOutletImpl.`getDetokenizedPath(ControllerState controllerState)`

  - ### Uses of ControllerState in org.apache.torque.generator.template.groovy

    Methods in org.apache.torque.generator.template.groovy that return ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `ControllerState` | TorqueGenGroovy.`getControllerState()` Returns the current controller state.

    Methods in org.apache.torque.generator.template.groovy with parameters of type ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,Object>` | GroovyOutlet.`createBinding(ControllerState controllerState)`
    `OutletResult` | GroovyOutlet.`execute(ControllerState controllerState)` Executes the generation process; the result is returned.
    `protected abstract String` | GroovyOutlet.`executeGroovy(Map<String,Object> binding, ControllerState controllerState)` Executes the Groovy script or template and retuns the reult.
    `protected String` | GroovyScriptOutlet.`executeGroovy(Map<String,Object> binding, ControllerState controllerState)`
    `protected String` | GroovyTemplateOutlet.`executeGroovy(Map<String,Object> binding, ControllerState controllerState)`

    Constructors in org.apache.torque.generator.template.groovy with parameters of type ControllerState
    Constructor and Description
    `TorqueGenGroovy(GroovyOutlet outlet, ControllerState controllerState)` Constructs a generator interface within the given controllerState.

  - ### Uses of ControllerState in org.apache.torque.generator.template.velocity

    Methods in org.apache.torque.generator.template.velocity that return ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `ControllerState` | TorqueGenVelocity.`getControllerState()` Returns the current controller state.

    Methods in org.apache.torque.generator.template.velocity with parameters of type ControllerState
    Modifier and Type | Method and Description
    --- | ---
    `OutletResult` | VelocityOutlet.`execute(ControllerState controllerState)` Executes the generation process; the result is returned.

    Constructors in org.apache.torque.generator.template.velocity with parameters of type ControllerState
    Constructor and Description
    `TorqueGenVelocity(VelocityOutlet outlet, ControllerState controllerState)` Constructs a generator interface within the given controllerState.

Copyright © 2000–2020 The Apache Software Foundation. All rights reserved.