Generator (bboss-velocity 6.1.5 API)

java.lang.Object
- bboss.org.apache.velocity.texen.Generator

public class Generator
extends java.lang.Object

A text/code generator class

字段概要

字段
限定符和类型	字段和说明
`protected java.lang.String`	`inputEncoding` This is the encoding for the input file(s) (templates).
`static java.lang.String`	`OUTPUT_PATH` Where the texen output will placed.
`protected java.lang.String`	`outputEncoding` This is the encoding for the output file(s).
`static java.lang.String`	`TEMPLATE_PATH` Where the velocity templates live.
`protected VelocityEngine`	`ve` Velocity engine.

构造器概要

构造器
构造器和说明
`Generator(java.util.Properties props)` Create a new Generator object with a given property set.
`Generator(java.lang.String propFile)` Create a new generator object with properties loaded from a file.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`protected void`	`fillContextDefaults(Context context)` Add properties that will aways be in the context by default
`protected void`	`fillContextHash(Context context, java.util.Hashtable objs)` Add all the contents of a Hashtable to the context.
`protected void`	`fillContextProperties(Context context)` Add objects to the context from the current properties.
`protected Context`	`getContext(java.util.Hashtable objs)` Create a new context and fill it with the elements of the objs Hashtable.
`static Generator`	`getInstance()` Create a new generator object with default properties.
`java.lang.String`	`getOutputPath()` Get the output path for the generated output.
`Template`	`getTemplate(java.lang.String templateName, java.lang.String encoding)` Returns a template, based on encoding and path.
`java.lang.String`	`getTemplatePath()` Get the template path.
`java.io.Writer`	`getWriter(java.lang.String path, java.lang.String encoding)` Returns a writer, based on encoding and path.
`java.lang.String`	`parse(java.lang.String controlTemplate, Context controlContext)` Parse the control template and merge it with the control context.
`java.lang.String`	`parse(java.lang.String inputTemplate, java.lang.String outputFile)` Parse an input and write the output to an output file.
`java.lang.String`	`parse(java.lang.String inputTemplate, java.lang.String outputFile, java.lang.String objectID, java.lang.Object object)` Parse an input and write the output to an output file.
`java.lang.String`	`parse(java.lang.String inputTemplate, java.lang.String inputEncoding, java.lang.String outputFile, java.lang.String outputEncoding, java.lang.String objectID, java.lang.Object object)` Parse an input and write the output to an output file.
`protected void`	`setDefaultProps()` Set default properties.
`void`	`setInputEncoding(java.lang.String inputEncoding)` Set the input (template) encoding.
`void`	`setOutputEncoding(java.lang.String outputEncoding)` Set the output encoding.
`void`	`setOutputPath(java.lang.String outputPath)` Set the output path for the generated output.
`void`	`setTemplatePath(java.lang.String templatePath)` Set the template path, where Texen will look for Velocity templates.
`void`	`setVelocityEngine(VelocityEngine ve)` Set the velocity engine.
`void`	`shutdown()` Properly shut down the generator, right now this is simply flushing and closing the file writers that we have been holding on to.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - OUTPUT_PATH
```
public static final java.lang.String OUTPUT_PATH
```
    Where the texen output will placed.
    
    另请参阅:
    
    常量字段值
  - TEMPLATE_PATH
```
public static final java.lang.String TEMPLATE_PATH
```
    Where the velocity templates live.
    
    另请参阅:
    
    常量字段值
  - outputEncoding
```
protected java.lang.String outputEncoding
```
    This is the encoding for the output file(s).
  - inputEncoding
```
protected java.lang.String inputEncoding
```
    This is the encoding for the input file(s) (templates).
  - ve
```
protected VelocityEngine ve
```
    Velocity engine.
- 构造器详细资料
  - Generator
```
public Generator(java.lang.String propFile)
```
    Create a new generator object with properties loaded from a file. If the file does not exist or any other exception occurs during the reading operation the default properties are used.
    
    参数:
    
    propFile - properties used to help populate the control context.
  - Generator
```
public Generator(java.util.Properties props)
```
    Create a new Generator object with a given property set. The property set will be duplicated.
    
    参数:
    
    props - properties object to help populate the control context.
- 方法详细资料
  - getInstance
```
public static Generator getInstance()
```
    Create a new generator object with default properties.
    
    返回:
    
    Generator generator used in the control context.
  - setVelocityEngine
```
public void setVelocityEngine(VelocityEngine ve)
```
    Set the velocity engine.
    
    参数:
    
    ve -
  - setDefaultProps
```
protected void setDefaultProps()
```
    Set default properties.
  - setTemplatePath
```
public void setTemplatePath(java.lang.String templatePath)
```
    Set the template path, where Texen will look for Velocity templates.
    
    参数:
    
    templatePath - template path for velocity templates.
  - getTemplatePath
```
public java.lang.String getTemplatePath()
```
    Get the template path.
    
    返回:
    
    String template path for velocity templates.
  - setOutputPath
```
public void setOutputPath(java.lang.String outputPath)
```
    Set the output path for the generated output.
    
    参数:
    
    outputPath -
  - getOutputPath
```
public java.lang.String getOutputPath()
```
    Get the output path for the generated output.
    
    返回:
    
    String output path for texen output.
  - setOutputEncoding
```
public void setOutputEncoding(java.lang.String outputEncoding)
```
    Set the output encoding.
    
    参数:
    
    outputEncoding -
  - setInputEncoding
```
public void setInputEncoding(java.lang.String inputEncoding)
```
    Set the input (template) encoding.
    
    参数:
    
    inputEncoding -
  - getWriter
```
public java.io.Writer getWriter(java.lang.String path,
                                java.lang.String encoding)
                         throws java.lang.Exception
```
    Returns a writer, based on encoding and path.
    
    参数:
    
    path - path to the output file
    
    encoding - output encoding
    
    返回:
    
    A Writer for this generator.
    
    抛出:
    
    java.lang.Exception
  - getTemplate
```
public Template getTemplate(java.lang.String templateName,
                            java.lang.String encoding)
                     throws java.lang.Exception
```
    Returns a template, based on encoding and path.
    
    参数:
    
    templateName - name of the template
    
    encoding - template encoding
    
    返回:
    
    A Template.
    
    抛出:
    
    java.lang.Exception
  - parse
```
public java.lang.String parse(java.lang.String inputTemplate,
                              java.lang.String outputFile)
                       throws java.lang.Exception
```
    Parse an input and write the output to an output file. If the output file parameter is null or an empty string the result is returned as a string object. Otherwise an empty string is returned.
    
    参数:
    
    inputTemplate - input template
    
    outputFile - output file
    
    返回:
    
    The parsed file.
    
    抛出:
    
    java.lang.Exception
  - parse
```
public java.lang.String parse(java.lang.String inputTemplate,
                              java.lang.String outputFile,
                              java.lang.String objectID,
                              java.lang.Object object)
                       throws java.lang.Exception
```
    Parse an input and write the output to an output file. If the output file parameter is null or an empty string the result is returned as a string object. Otherwise an empty string is returned. You can add objects to the context with the objs Hashtable.
    
    参数:
    
    inputTemplate - input template
    
    outputFile - output file
    
    objectID - id for object to be placed in the control context
    
    object - object to be placed in the context
    
    返回:
    
    String generated output from velocity
    
    抛出:
    
    java.lang.Exception
  - parse
```
public java.lang.String parse(java.lang.String inputTemplate,
                              java.lang.String inputEncoding,
                              java.lang.String outputFile,
                              java.lang.String outputEncoding,
                              java.lang.String objectID,
                              java.lang.Object object)
                       throws java.lang.Exception
```
    Parse an input and write the output to an output file. If the output file parameter is null or an empty string the result is returned as a string object. Otherwise an empty string is returned. You can add objects to the context with the objs Hashtable.
    
    参数:
    
    inputTemplate - input template
    
    inputEncoding - template encoding
    
    outputFile - output file
    
    outputEncoding - outputEncoding encoding of output file
    
    objectID - id for object to be placed in the control context
    
    object - object to be placed in the context
    
    返回:
    
    String generated output from velocity
    
    抛出:
    
    java.lang.Exception
  - parse
```
public java.lang.String parse(java.lang.String controlTemplate,
                              Context controlContext)
                       throws java.lang.Exception
```
    Parse the control template and merge it with the control context. This is the starting point in texen.
    
    参数:
    
    controlTemplate - control template
    
    controlContext - control context
    
    返回:
    
    String generated output
    
    抛出:
    
    java.lang.Exception
  - getContext
```
protected Context getContext(java.util.Hashtable objs)
```
    Create a new context and fill it with the elements of the objs Hashtable. Default objects and objects that comes from the properties of this Generator object is also added.
    
    参数:
    
    objs - objects to place in the control context
    
    返回:
    
    Context context filled with objects
  - fillContextHash
```
protected void fillContextHash(Context context,
                               java.util.Hashtable objs)
```
    Add all the contents of a Hashtable to the context.
    
    参数:
    
    context - context to fill with objects
    
    objs - source of objects
  - fillContextDefaults
```
protected void fillContextDefaults(Context context)
```
    Add properties that will aways be in the context by default
    
    参数:
    
    context - control context to fill with default values.
  - fillContextProperties
```
protected void fillContextProperties(Context context)
```
    Add objects to the context from the current properties.
    
    参数:
    
    context - control context to fill with objects that are specified in the default.properties file
  - shutdown
```
public void shutdown()
```
    Properly shut down the generator, right now this is simply flushing and closing the file writers that we have been holding on to.

类 Generator

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

OUTPUT_PATH

TEMPLATE_PATH

outputEncoding

inputEncoding

ve

构造器详细资料

Generator

Generator

方法详细资料

getInstance

setVelocityEngine

setDefaultProps

setTemplatePath

getTemplatePath

setOutputPath

getOutputPath

setOutputEncoding

setInputEncoding

getWriter

getTemplate

parse

parse

parse

parse

getContext

fillContextHash

fillContextDefaults

fillContextProperties

shutdown