org.opends.server.tools.makeldif
Class TemplateEntry

java.lang.Object
  extended by org.opends.server.tools.makeldif.TemplateEntry

public class TemplateEntry
extends java.lang.Object

This class defines an entry that is generated using a MakeLDIF branch or template.


Constructor Summary
TemplateEntry(Branch branch)
          Creates a new template entry that will be associated with the provided branch.
TemplateEntry(Template template, DN parentDN)
          Creates a new template entry that will be associated with the provided template.
 
Method Summary
 void addValue(TemplateValue value)
          Adds the provided template value to this entry.
 Branch getBranch()
          Retrieves the branch used to generate this entry.
 DN getDN()
          Retrieves the DN for this template entry, if it is known.
 DN getParentDN()
          Retrieves the DN of the parent entry for this template entry.
 Template getTemplate()
          Retrieves the template used to generate this entry.
 TemplateValue getValue(AttributeType attributeType)
          Retrieves the value for the specified attribute, if defined.
 java.util.List<TemplateValue> getValues(AttributeType attributeType)
          Retrieves the set of values for the specified attribute, if defined.
 boolean hasAttribute(AttributeType attributeType)
          Indicates whether this entry contains one or more values for the specified attribute type.
 Entry toEntry()
          Retrieves this template entry as an Entry object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TemplateEntry

public TemplateEntry(Branch branch)
Creates a new template entry that will be associated with the provided branch.

Parameters:
branch - The branch to use when creating this template entry.

TemplateEntry

public TemplateEntry(Template template,
                     DN parentDN)
Creates a new template entry that will be associated with the provided template.

Parameters:
template - The template used to generate this entry.
parentDN - The DN of the parent entry for this template entry.
Method Detail

getBranch

public Branch getBranch()
Retrieves the branch used to generate this entry.

Returns:
The branch used to generate this entry, or null if it is associated with a template instead of a branch.

getTemplate

public Template getTemplate()
Retrieves the template used to generate this entry.

Returns:
The template used to generate this entry, or null if it is associated with a branch instead of a template.

getParentDN

public DN getParentDN()
Retrieves the DN of the parent entry for this template entry.

Returns:
The DN of the parent entry for this template entry, or null if there is no parent DN.

getDN

public DN getDN()
Retrieves the DN for this template entry, if it is known.

Returns:
The DN for this template entry if it is known, or null if it cannot yet be determined.

hasAttribute

public boolean hasAttribute(AttributeType attributeType)
Indicates whether this entry contains one or more values for the specified attribute type.

Parameters:
attributeType - The attribute type for which to make the determination.
Returns:
true if this entry contains one or more values for the specified attribute type, or false if not.

getValue

public TemplateValue getValue(AttributeType attributeType)
Retrieves the value for the specified attribute, if defined. If the specified attribute has multiple values, then the first will be returned.

Parameters:
attributeType - The attribute type for which to retrieve the value.
Returns:
The value for the specified attribute, or null if there are no values for that attribute type.

getValues

public java.util.List<TemplateValue> getValues(AttributeType attributeType)
Retrieves the set of values for the specified attribute, if defined.

Parameters:
attributeType - The attribute type for which to retrieve the set of values.
Returns:
The set of values for the specified attribute, or null if there are no values for that attribute type.

addValue

public void addValue(TemplateValue value)
Adds the provided template value to this entry.

Parameters:
value - The value to add to this entry.

toEntry

public Entry toEntry()
Retrieves this template entry as an Entry object.

Returns:
The Entry object for this template entry.