public abstract class Tag extends Object
Constructor and Description |
---|
Tag() |
Modifier and Type | Method and Description |
---|---|
abstract boolean |
allowedInBranch()
Indicates whether this tag is allowed for use in the extra lines for
branches.
|
abstract TagResult |
generateValue(TemplateEntry templateEntry,
TemplateValue templateValue)
Generates the content for this tag by appending it to the provided tag.
|
abstract String |
getName()
Retrieves the name for this tag.
|
void |
initializeForBranch(TemplateFile templateFile,
Branch branch,
String[] arguments,
int lineNumber,
List<LocalizableMessage> warnings)
Performs any initialization for this tag that may be needed while parsing
a branch definition.
|
void |
initializeForParent(TemplateEntry parentEntry)
Performs any initialization for this tag that may be needed when starting
to generate entries below a new parent.
|
abstract void |
initializeForTemplate(TemplateFile templateFile,
Template template,
String[] arguments,
int lineNumber,
List<LocalizableMessage> warnings)
Performs any initialization for this tag that may be needed while parsing
a template definition.
|
public Tag()
public abstract String getName()
public abstract boolean allowedInBranch()
true
if this tag may be used in branch definitions,
or false
if not.public void initializeForBranch(TemplateFile templateFile, Branch branch, String[] arguments, int lineNumber, List<LocalizableMessage> warnings) throws InitializationException
templateFile
- The template file in which this tag is used.branch
- The branch in which this tag is used.arguments
- The set of arguments provided for this tag.lineNumber
- The line number on which this tag appears in the
template file.warnings
- A list into which any appropriate warning messages
may be placed.InitializationException
- If a problem occurs while initializing
this tag.public abstract void initializeForTemplate(TemplateFile templateFile, Template template, String[] arguments, int lineNumber, List<LocalizableMessage> warnings) throws InitializationException
templateFile
- The template file in which this tag is used.template
- The template in which this tag is used.arguments
- The set of arguments provided for this tag.lineNumber
- The line number on which this tag appears in the
template file.warnings
- A list into which any appropriate warning messages
may be placed.InitializationException
- If a problem occurs while initializing
this tag.public void initializeForParent(TemplateEntry parentEntry)
parentEntry
- The entry below which the new entries will be
generated.public abstract TagResult generateValue(TemplateEntry templateEntry, TemplateValue templateValue)
templateEntry
- The entry for which this tag is being generated.templateValue
- The template value to which the generated content
should be appended.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.