001 /* 002 * Copyright 2015-2016 UnboundID Corp. 003 * All Rights Reserved. 004 */ 005 /* 006 * Copyright (C) 2015-2016 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 */ 021 package com.unboundid.ldif; 022 023 024 025 026 027 028 /** 029 * This interface is used by the LDIFWriter to translate or exclude change 030 * records before they are written. 031 */ 032 public interface LDIFWriterChangeRecordTranslator 033 { 034 /** 035 * Applies some special transformation or filtering to the original change 036 * record. 037 * 038 * @param original The original change record that was to be written. 039 * 040 * @return The change record that should be written. This can be the 041 * original parameter change record, a newly-constructed change 042 * record, or {@code null} to signal that the change record should 043 * not be written. Note, however, that if the original record 044 * provided as a parameter is altered, then the change will be 045 * visible to anything that references that change record. If you 046 * are not sure about whether changes to the original change record 047 * are acceptable, it is recommended that you use the 048 * {@code duplicate()} method to create a copy of the original and 049 * make the necessary changes to that duplicate. 050 */ 051 LDIFChangeRecord translateChangeRecordToWrite(LDIFChangeRecord original); 052 }