com.unboundid.ldif

Class AggregateLDIFWriterEntryTranslator

java.lang.Object

com.unboundid.ldif.AggregateLDIFWriterEntryTranslator

All Implemented Interfaces:

LDIFWriterEntryTranslator

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

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
Entry	translateEntryToWrite(Entry original) 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

AggregateLDIFWriterEntryTranslator

public AggregateLDIFWriterEntryTranslator(@Nullable
                                  LDIFWriterEntryTranslator... translators)

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

Parameters:

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

AggregateLDIFWriterEntryTranslator

public AggregateLDIFWriterEntryTranslator(@Nullable
                                  java.util.Collection<? extends LDIFWriterEntryTranslator> translators)

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

Parameters:

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

Method Detail

translateEntryToWrite

@Nullable
public Entry translateEntryToWrite(@Nullable
                                   Entry original)

Applies some special transformation or filtering to the original Entry.

Specified by:

translateEntryToWrite in interface LDIFWriterEntryTranslator

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.