com.unboundid.ldif
Interface LDIFReaderEntryTranslator
- All Known Subinterfaces:
- EntryTransformation
- All Known Implementing Classes:
- AddAttributeTransformation, AggregateLDIFReaderEntryTranslator, ExcludeAttributeTransformation, ExcludeEntryTransformation, FlattenSubtreeTransformation, MoveSubtreeTransformation, RedactAttributeTransformation, RenameAttributeTransformation, ReplaceAttributeTransformation, ReplaceWithCounterTransformation, ScrambleAttributeTransformation, TransformLDIF, ValidateLDIF
@Extensible
@ThreadSafety(level=INTERFACE_THREADSAFE)
public interface LDIFReaderEntryTranslator
This interface is used by the LDIFReader to translate entries read from the
input or filter them out before they are returned via
LDIFReader.readEntry()
.
Method Summary |
Entry |
translate(Entry original,
long firstLineNumber)
Applies some special transformation or filtering to the original Entry. |
translate
Entry translate(Entry original,
long firstLineNumber)
throws LDIFException
- Applies some special transformation or filtering to the original Entry.
- 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.
- Throws:
LDIFException
- If there is an exception during processing. This
exception will be re-thrown to the caller of
readEntry.