xbn.template.util
Class GetTemplateFrom

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.template.util.GetTemplateFrom

Direct Known Subclasses:

GetTFFile, GetTFString, GetTOGFrom

public class GetTemplateFrom

extends XBNObject

Base class for quickly getting a Template object from a ForLineRetrieval.

Source code: GetTemplateFrom.java.

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

GetTemplateFrom(String s_templateName, ForLineRetrieval flr_srcTxt, GapConfig gap_config, Outputter optr_dbg, TFilter template_filter)
Create a Template from source text.

Method Summary

protected Template	createTemplate(String s_templateName, ForLineRetrieval flr_srcTxt, TParseConfig tp_config, TFilter template_filter) Create a Template from the constructor parameters.
Template	getTemplate() Get the Template from the constructor parameters.

Methods inherited from class xbn.XBNObject

getXMsgPrefix, sop, sopl, sopl, throwAX, throwAXIfBadStr, throwAXIfNull, throwAXSpoof

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetTemplateFrom

public GetTemplateFrom(String s_templateName,
                       ForLineRetrieval flr_srcTxt,
                       GapConfig gap_config,
                       Outputter optr_dbg,
                       TFilter template_filter)

Create a Template from source text.

Parameters:

s_templateName - The name of the Template. This value is passed directly to the Template constructor

flr_srcTxt - The source text for the Template. This value is passed directly to the Template constructor.

gap_config - The definition of a gap. May not be null. This value is passed directly to the TParseConfig constructor.

optr_dbg - The Outputter to use for debugging while parsing the file text. May not be null. This value is passed directly to the TParseConfig constructor.

template_filter - The TFilter to validate the integrity of the retrieved Template. This value is passed directly to the Template constructor.

Throws:

AssertException - If an AssertException or TemplateFormatException are thrown, for any reason, by either the TParseConfig or Template constructors.

Method Detail

createTemplate

protected Template createTemplate(String s_templateName,
                                  ForLineRetrieval flr_srcTxt,
                                  TParseConfig tp_config,
                                  TFilter template_filter)

Create a Template from the constructor parameters.

getTemplate

public final Template getTemplate()

Get the Template from the constructor parameters.