com.unboundid.ldif
Interface LDIFReaderChangeRecordTranslator
- All Known Subinterfaces:
- LDIFChangeRecordTransformation
- All Known Implementing Classes:
- AggregateLDIFReaderChangeRecordTranslator, ExcludeAttributeTransformation, MoveSubtreeTransformation, RedactAttributeTransformation, RenameAttributeTransformation, ScrambleAttributeTransformation
@Extensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public interface LDIFReaderChangeRecordTranslator
This interface is used by the LDIFReader to translate change records read
from the input or filter them out before they are returned via
LDIFReader.readChangeRecord()
.
translate
LDIFChangeRecord translate(LDIFChangeRecord original,
long firstLineNumber)
throws LDIFException
- Applies some special transformation or filtering to the original change
record.
- Parameters:
original
- The original change record that was read and
parsed from the input file.firstLineNumber
- The first line number of the LDIF change record.
This is most useful when throwing an
LDIFException
.
- Returns:
- The LDIF change record that should be returned in the call to
LDIFReader.readChangeRecord()
. This can be the original
parameter change record, a newly constructed change record, or
null
to signal that the provided change record should be
skipped.
- Throws:
LDIFException
- If there is an exception during processing. This
exception will be re-thrown to the caller of
readChangeRecord.