com.ibm.dse.tools.workbench.tbg
Class TagInclude

java.lang.Object
  |
  +--com.ibm.dse.tools.workbench.tbg.TagInclude

public class TagInclude
extends java.lang.Object
implements TagProcessor

This class implements an include TBG tag.


Fields inherited from interface com.ibm.dse.tools.workbench.tbg.TbgNames
ATTRIB_LAST, ATTRIB_SEP, ATTRIBUTE, END_SIMPLE_TAG, END_TAG, INI_FINAL_TAG, INI_TAG, LITERAL, LITERAL_LAST1, LITERAL_LAST2, LITERAL_LAST3, LITERAL_SEP1, LITERAL_SEP2, LITERAL_SEP3
 
Constructor Summary
TagInclude()
          This constructor creates a TagInclude object.
 
Method Summary
 java.lang.String generate(TbgContext aContext)
          Treats an include file operation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TagInclude

public TagInclude()
This constructor creates a TagInclude object.
Method Detail

generate

public java.lang.String generate(TbgContext aContext)
                          throws WorkbenchException,
                                 TbgException
Treats an include file operation. Opens the new input source and appends the generation result to the actual output writer.
Specified by:
generate in interface TagProcessor
Parameters:
aContext - TbgContext The actual context.
Returns:
java.lang.String Returns a null value because this tag is a control tag.
Throws:
TbgException - When an break exception has been thrown.
WorkbenchException - Could be thrown writing to the log file, opening the sub-template, or generating the content of the included template.