com.unboundid.ldif

Interface LDIFWriterEntryTranslator

All Known Subinterfaces:

EntryTransformation

All Known Implementing Classes:

AddAttributeTransformation, AggregateLDIFWriterEntryTranslator, ExcludeAllEntriesTransformation, ExcludeAttributeTransformation, ExcludeEntryTransformation, FlattenSubtreeTransformation, MoveSubtreeTransformation, RedactAttributeTransformation, RenameAttributeTransformation, ReplaceAttributeTransformation, ReplaceWithCounterTransformation, ScrambleAttributeTransformation

@Extensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public interface LDIFWriterEntryTranslator

This interface is used by the LDIFWriter to translate or exclude entries before they are written.

Method Summary

Methods

Modifier and Type	Method and Description
Entry	translateEntryToWrite(Entry original) Applies some special transformation or filtering to the original Entry.

Method Detail

translateEntryToWrite

@Nullable
Entry translateEntryToWrite(@NotNull
                                   Entry original)

Applies some special transformation or filtering to the original Entry.

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.