org.opends.server.tools.makeldif
Class TemplateLine

java.lang.Object
  org.opends.server.tools.makeldif.TemplateLine

public class TemplateLine
extends java.lang.Object

This class defines a line that may appear in a template or branch. It may contain any number of tags to be evaluated.

Constructor Summary

TemplateLine(AttributeType attributeType, int lineNumber, Tag[] tags)
Creates a new template line with the provided information.

Method Summary

TagResult	generateLine(TemplateEntry templateEntry) Generates the content for this template line and places it in the provided template entry.
AttributeType	getAttributeType() Retrieves the attribute type for this template line.
int	getLineNumber() Retrieves the line number on which this template line appears in the template file.
Tag[]	getTags() Retrieves the set of tags for this template line.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateLine

public TemplateLine(AttributeType attributeType,
                    int lineNumber,
                    Tag[] tags)

Creates a new template line with the provided information.

Parameters:

attributeType - The attribute type for this template line.

lineNumber - The line number on which this template line appears in the template file.

tags - The set of tags for this template line.

Method Detail

getAttributeType

public AttributeType getAttributeType()

Retrieves the attribute type for this template line.

Returns:

The attribute type for this template line.

getLineNumber

public int getLineNumber()

Retrieves the line number on which this template line appears in the template file.

Returns:

The line number on which this template line appears in the template file.

getTags

public Tag[] getTags()

Retrieves the set of tags for this template line.

Returns:

The set of tags for this template line.

generateLine

public TagResult generateLine(TemplateEntry templateEntry)

Generates the content for this template line and places it in the provided template entry.

Parameters:

templateEntry - The template entry being generated.

Returns:

The result of generating the template line.