com.unboundid.ldif

Interface LDIFWriterChangeRecordTranslator

All Known Subinterfaces:

LDIFChangeRecordTransformation

All Known Implementing Classes:

AggregateLDIFWriterChangeRecordTranslator, ExcludeAttributeTransformation, ExcludeChangeTypeTransformation, MoveSubtreeTransformation, RedactAttributeTransformation, RenameAttributeTransformation, ScrambleAttributeTransformation

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

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

Method Summary

Modifier and Type	Method and Description
LDIFChangeRecord	translateChangeRecordToWrite(LDIFChangeRecord original) Applies some special transformation or filtering to the original change record.

Method Detail

translateChangeRecordToWrite

@Nullable
LDIFChangeRecord translateChangeRecordToWrite(@NotNull
                                                        LDIFChangeRecord original)

Applies some special transformation or filtering to the original change record.

Parameters:

original - The original change record that was to be written.

Returns:

The change record that should be written. This can be the original parameter change record, a newly-constructed change record, or null to signal that the change record should not be written. Note, however, that if the original record provided as a parameter is altered, then the change will be visible to anything that references that change record. If you are not sure about whether changes to the original change record 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.