001/*
002 * Copyright 2008-2017 UnboundID Corp.
003 * All Rights Reserved.
004 */
005/*
006 * Copyright (C) 2008-2017 UnboundID Corp.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU General Public License (GPLv2 only)
010 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
011 * as published by the Free Software Foundation.
012 *
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Public License for more details.
017 *
018 * You should have received a copy of the GNU General Public License
019 * along with this program; if not, see <http://www.gnu.org/licenses>.
020 */
021package com.unboundid.ldif;
022
023
024
025import com.unboundid.ldap.sdk.Entry;
026import com.unboundid.util.Extensible;
027import com.unboundid.util.ThreadSafety;
028import com.unboundid.util.ThreadSafetyLevel;
029
030
031
032/**
033 * This interface is used by the LDIFWriter to translate or exclude entries
034 * before they are written.
035 */
036@Extensible()
037@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
038public interface LDIFWriterEntryTranslator
039{
040  /**
041   * Applies some special transformation or filtering to the original Entry.
042   *
043   * @param original  The original Entry that was to be written.
044   *
045   * @return  The Entry that should be written.  This can be the original
046   *          parameter Entry, a newly-constructed Entry, or {@code null} to
047   *          signal that this Entry should not be written.  Note, however, that
048   *          if the original entry provided as a parameter is altered, then
049   *          the change will be visible to anything that references that entry.
050   *          If you are not sure about whether changes to the original entry
051   *          are acceptable, it is recommended that you use the
052   *          {@code duplicate()} method to create a copy of the original and
053   *          make the necessary changes to that duplicate.
054   */
055  Entry translateEntryToWrite(Entry original);
056}