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 LDIFReader to translate change records read
030     * from the input or filter them out before they are returned via
031     * {@code LDIFReader#readChangeRecord}.
032     */
033    public interface LDIFReaderChangeRecordTranslator
034    {
035      /**
036       * Applies some special transformation or filtering to the original change
037       * record.
038       *
039       * @param  original         The original change record that was read and
040       *                          parsed from the input file.
041       * @param  firstLineNumber  The first line number of the LDIF change record.
042       *                          This is most useful when throwing an
043       *                          {@code LDIFException}.
044       *
045       * @return  The LDIF change record that should be returned in the call to
046       *          {@code LDIFReader#readChangeRecord}. This can be the original
047       *          parameter change record, a newly constructed change record, or
048       *          {@code null} to signal that the provided change record should be
049       *          skipped.
050       *
051       * @throws  LDIFException  If there is an exception during processing.  This
052       *                         exception will be re-thrown to the caller of
053       *                         readChangeRecord.
054       */
055      LDIFChangeRecord translate(LDIFChangeRecord original, long firstLineNumber)
056           throws LDIFException;
057    }