001    /*
002     * Copyright 2008-2016 UnboundID Corp.
003     * All Rights Reserved.
004     */
005    /*
006     * Copyright (C) 2008-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    import com.unboundid.ldap.sdk.Entry;
026    
027    
028    
029    /**
030     * This interface is used by the LDIFReader to translate entries read from the
031     * input or filter them out before they are returned via
032     * {@code LDIFReader#readEntry}.
033     */
034    public interface LDIFReaderEntryTranslator
035    {
036      /**
037       * Applies some special transformation or filtering to the original Entry.
038       *
039       * @param  original         The original Entry that was read and parsed from
040       *                          the input file.
041       * @param  firstLineNumber  The first line number of the LDIF record
042       *                          corresponding to the read Entry.  This is most
043       *                          useful when throwing an LDIFException.
044       *
045       * @return  The Entry that should be returned in the call to
046       *          {@code LDIFReader#readEntry}. This can be the original parameter
047       *          Entry, a newly constructed Entry, or {@code null} to signal that
048       *          the provided Entry should be skipped.
049       *
050       * @throws  LDIFException  If there is an exception during processing.  This
051       *                         exception will be re-thrown to the caller of
052       *                         readEntry.
053       */
054      Entry translate(Entry original, long firstLineNumber)
055           throws LDIFException;
056    }