org.opends.server.tools.makeldif
Class SequentialTag

java.lang.Object
  extended by org.opends.server.tools.makeldif.Tag
      extended by org.opends.server.tools.makeldif.SequentialTag

public class SequentialTag
extends Tag

This class defines a tag that is used to include a sequentially-incrementing integer in the generated values.


Constructor Summary
SequentialTag()
          Creates a new instance of this sequential tag.
 
Method Summary
 boolean allowedInBranch()
          Indicates whether this tag is allowed for use in the extra lines for branches.
 TagResult generateValue(TemplateEntry templateEntry, TemplateValue templateValue)
          Generates the content for this tag by appending it to the provided tag.
 java.lang.String getName()
          Retrieves the name for this tag.
 void initializeForBranch(TemplateFile templateFile, Branch branch, java.lang.String[] arguments, int lineNumber, java.util.List<Message> 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.
 void initializeForTemplate(TemplateFile templateFile, Template template, java.lang.String[] arguments, int lineNumber, java.util.List<Message> warnings)
          Performs any initialization for this tag that may be needed while parsing a template definition.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SequentialTag

public SequentialTag()
Creates a new instance of this sequential tag.

Method Detail

getName

public java.lang.String getName()
Retrieves the name for this tag.

Specified by:
getName in class Tag
Returns:
The name for this tag.

allowedInBranch

public boolean allowedInBranch()
Indicates whether this tag is allowed for use in the extra lines for branches.

Specified by:
allowedInBranch in class Tag
Returns:
true if this tag may be used in branch definitions, or false if not.

initializeForBranch

public void initializeForBranch(TemplateFile templateFile,
                                Branch branch,
                                java.lang.String[] arguments,
                                int lineNumber,
                                java.util.List<Message> warnings)
                         throws InitializationException
Performs any initialization for this tag that may be needed while parsing a branch definition.

Overrides:
initializeForBranch in class Tag
Parameters:
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.
Throws:
InitializationException - If a problem occurs while initializing this tag.

initializeForTemplate

public void initializeForTemplate(TemplateFile templateFile,
                                  Template template,
                                  java.lang.String[] arguments,
                                  int lineNumber,
                                  java.util.List<Message> warnings)
                           throws InitializationException
Performs any initialization for this tag that may be needed while parsing a template definition.

Specified by:
initializeForTemplate in class Tag
Parameters:
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.
Throws:
InitializationException - If a problem occurs while initializing this tag.

initializeForParent

public void initializeForParent(TemplateEntry parentEntry)
Performs any initialization for this tag that may be needed when starting to generate entries below a new parent.

Overrides:
initializeForParent in class Tag
Parameters:
parentEntry - The entry below which the new entries will be generated.

generateValue

public TagResult generateValue(TemplateEntry templateEntry,
                               TemplateValue templateValue)
Generates the content for this tag by appending it to the provided tag.

Specified by:
generateValue in class Tag
Parameters:
templateEntry - The entry for which this tag is being generated.
templateValue - The template value to which the generated content should be appended.
Returns:
The result of generating content for this tag.