com.unboundid.ldap.sdk.transformations

Class ExcludeAllEntriesTransformation

java.lang.Object

com.unboundid.ldap.sdk.transformations.ExcludeAllEntriesTransformation

All Implemented Interfaces:

EntryTransformation, LDIFReaderEntryTranslator, LDIFWriterEntryTranslator, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ExcludeAllEntriesTransformation
extends java.lang.Object
implements EntryTransformation, java.io.Serializable

This class provides an entry transformation that will simply suppress all entries. It can be useful when processing a series of LDIF records if you only want to preserve change records and suppress all entries.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExcludeAllEntriesTransformation() Creates a new instance of this transformation.

Method Summary

Modifier and Type	Method and Description
Entry	transformEntry(Entry entry) Applies an appropriate transformation to the provided entry.
Entry	translate(Entry original, long firstLineNumber) Applies some special transformation or filtering to the original Entry.
Entry	translateEntryToWrite(Entry original) Applies some special transformation or filtering to the original Entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcludeAllEntriesTransformation

public ExcludeAllEntriesTransformation()

Creates a new instance of this transformation.

Method Detail

transformEntry

@Nullable
public Entry transformEntry(@NotNull
                                      Entry entry)

Applies an appropriate transformation to the provided entry.

Specified by:

transformEntry in interface EntryTransformation

Parameters:

entry - The entry to transform.

Returns:

A copy of the entry with any appropriate transformation applied, the original entry if no transformations were necessary, or null if the entry should be suppressed.

translate

@Nullable
public Entry translate(@NotNull
                                 Entry original,
                                 long firstLineNumber)

Applies some special transformation or filtering to the original Entry.

Specified by:

translate in interface LDIFReaderEntryTranslator

Parameters:

original - The original Entry that was read and parsed from the input file.

firstLineNumber - The first line number of the LDIF record corresponding to the read Entry. This is most useful when throwing an LDIFException.

Returns:

The Entry that should be returned in the call to LDIFReader.readEntry(). This can be the original parameter Entry, a newly constructed Entry, or null to signal that the provided Entry should be skipped.

translateEntryToWrite

@Nullable
public Entry translateEntryToWrite(@NotNull
                                             Entry original)

Applies some special transformation or filtering to the original Entry.

Specified by:

translateEntryToWrite in interface LDIFWriterEntryTranslator

Parameters:

original - The original Entry that was to be written.

Returns:

The Entry that should be written. This can be the original parameter Entry, a newly-constructed Entry, or null to signal that this Entry should not be written. Note, however, that if the original entry provided as a parameter is altered, then the change will be visible to anything that references that entry. If you are not sure about whether changes to the original entry are acceptable, it is recommended that you use the duplicate() method to create a copy of the original and make the necessary changes to that duplicate.