org.opends.server.types
Class LDIFImportResult

java.lang.Object
  extended by org.opends.server.types.LDIFImportResult

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public final class LDIFImportResult
extends java.lang.Object

This class defines a data structure for providing information about the state of a completed LDIF import, including the total number of entries read, skipped, and rejected.


Constructor Summary
LDIFImportResult(long entriesRead, long entriesRejected, long entriesSkipped)
          Creates a new LDIF import result object with the provided information.
 
Method Summary
 long getEntriesImported()
          Retrieves the total number of entries that were successfully imported.
 long getEntriesRead()
          Retrieves the total number of entries read during the import, including those that were later rejected or skipped.
 long getEntriesRejected()
          Retrieves the total number of entries rejected during the import.
 long getEntriesSkipped()
          Retrieves the total number of entries skipped during the import.
 java.lang.String toString()
          Retrieves a string representation of this LDIF import result object.
 void toString(java.lang.StringBuilder buffer)
          Appends a string representation of this LDIF import result object to the provided buffer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LDIFImportResult

public LDIFImportResult(long entriesRead,
                        long entriesRejected,
                        long entriesSkipped)
Creates a new LDIF import result object with the provided information.

Parameters:
entriesRead - The total number of entries read during the import, including those that were later rejected or skipped.
entriesRejected - The total number of entries rejected during the import.
entriesSkipped - The total number of entries skipped during the import.
Method Detail

getEntriesRead

public long getEntriesRead()
Retrieves the total number of entries read during the import, including those that were later rejected or skipped.

Returns:
The total number of entries read during the import, including those that were later rejected or skipped.

getEntriesImported

public long getEntriesImported()
Retrieves the total number of entries that were successfully imported.

Returns:
The total number of entries that were successfully imported.

getEntriesRejected

public long getEntriesRejected()
Retrieves the total number of entries rejected during the import.

Returns:
The total number of entries rejected during the import.

getEntriesSkipped

public long getEntriesSkipped()
Retrieves the total number of entries skipped during the import.

Returns:
The total number of entries skipped during the import.

toString

public java.lang.String toString()
Retrieves a string representation of this LDIF import result object.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this LDIF import result object.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDIF import result object to the provided buffer.

Parameters:
buffer - The buffer to which the information should be appended.