org.opends.server.tools.makeldif
Class TagResult

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

public class TagResult
extends java.lang.Object

This class defines a data structure that provides information about the result of tag processing.


Field Summary
static TagResult OMIT_FROM_ENTRY
          A tag result that indicates the value should not be included in the entry, but all other processing should continue.
static TagResult STOP_PROCESSING
          A tag result in whihc all components have a value of false.
static TagResult SUCCESS_RESULT
          A tag result in which all components have a value of true.
 
Constructor Summary
TagResult(boolean keepProcessingLine, boolean keepProcessingEntry, boolean keepProcessingParent, boolean keepProcessingTemplateFile)
          Creates a new tag result object with the provided information.
 
Method Summary
 boolean keepProcessingEntry()
          Indicates whether to continue processing for the current entry.
 boolean keepProcessingLine()
          Indicates whether to continue processing for the current line.
 boolean keepProcessingParent()
          Indicates whether to continue processing entries below the current parent.
 boolean keepProcessingTemplateFile()
          Indicates whether to keep processing entries for the template file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SUCCESS_RESULT

public static final TagResult SUCCESS_RESULT
A tag result in which all components have a value of true.


OMIT_FROM_ENTRY

public static final TagResult OMIT_FROM_ENTRY
A tag result that indicates the value should not be included in the entry, but all other processing should continue.


STOP_PROCESSING

public static final TagResult STOP_PROCESSING
A tag result in whihc all components have a value of false.

Constructor Detail

TagResult

public TagResult(boolean keepProcessingLine,
                 boolean keepProcessingEntry,
                 boolean keepProcessingParent,
                 boolean keepProcessingTemplateFile)
Creates a new tag result object with the provided information.

Parameters:
keepProcessingLine - Indicates whether to continue processing for the current line. If not, then the line will not be included in the entry.
keepProcessingEntry - Indicates whether to continue processing for the current entry. If not, then the entry will not be included in the data.
keepProcessingParent - Indicates whether to continue processing entries below the current parent in the template file.
keepProcessingTemplateFile - Indicates whether to continue processing entries for the template file.
Method Detail

keepProcessingLine

public boolean keepProcessingLine()
Indicates whether to continue processing for the current line. If this is false, then the current line will not be included in the entry. It will have no impact on whehter the entry itself is included in the generated LDIF.

Returns:
true if the line should be included in the entry, or false if not.

keepProcessingEntry

public boolean keepProcessingEntry()
Indicates whether to continue processing for the current entry. If this is false, then the current entry will not be included in the generated LDIF, and processing will resume with the next entry below the current parent.

Returns:
true if the entry should be included in the generated LDIF, or false if not.

keepProcessingParent

public boolean keepProcessingParent()
Indicates whether to continue processing entries below the current parent. If this is false, then the current entry will not be included, and processing will resume below the next parent in the template file.

Returns:
true if processing for the current parent should continue, or false if not.

keepProcessingTemplateFile

public boolean keepProcessingTemplateFile()
Indicates whether to keep processing entries for the template file. If this is false, then LDIF processing will end immediately (and the current entry will not be included).

Returns:
true if processing for the template file should continue, or false if not.