com.unboundid.ldif

Class AggregateLDIFReaderEntryTranslator

java.lang.Object

com.unboundid.ldif.AggregateLDIFReaderEntryTranslator

All Implemented Interfaces:

LDIFReaderEntryTranslator

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class AggregateLDIFReaderEntryTranslator
extends java.lang.Object
implements LDIFReaderEntryTranslator

This class provides an implementation of an LDIF reader entry translator that can be used to invoke multiple LDIF reader entry translators for each entry to be processed.

Constructor Summary

Constructors

Constructor and Description
AggregateLDIFReaderEntryTranslator(java.util.Collection<? extends LDIFReaderEntryTranslator> translators) Creates a new aggregate LDIF reader entry translator that will invoke all of the provided translators for each entry to be processed.
AggregateLDIFReaderEntryTranslator(LDIFReaderEntryTranslator... translators) Creates a new aggregate LDIF reader entry translator that will invoke all of the provided translators for each entry to be processed.

Method Summary

Modifier and Type	Method and Description
Entry	translate(Entry original, long firstLineNumber) 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

AggregateLDIFReaderEntryTranslator

public AggregateLDIFReaderEntryTranslator(@Nullable
                                          LDIFReaderEntryTranslator... translators)

Creates a new aggregate LDIF reader entry translator that will invoke all of the provided translators for each entry to be processed.

Parameters:

translators - The set of LDIF reader entry translators to be invoked for each entry to be processed.

AggregateLDIFReaderEntryTranslator

public AggregateLDIFReaderEntryTranslator(@Nullable
                                          java.util.Collection<? extends LDIFReaderEntryTranslator> translators)

Creates a new aggregate LDIF reader entry translator that will invoke all of the provided translators for each entry to be processed.

Parameters:

translators - The set of LDIF reader entry translators to be invoked for each entry to be processed.

Method Detail

translate

@Nullable
public Entry translate(@Nullable
                                 Entry original,
                                 long firstLineNumber)
                          throws LDIFException

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.

Throws:

LDIFException - If there is an exception during processing. This exception will be re-thrown to the caller of readEntry.