001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2006-2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.tools.makeldif;
028    
029    
030    
031    import java.io.IOException;
032    
033    import org.opends.server.types.Entry;
034    
035    
036    
037    /**
038     * This interface defines a method that may be used to write entries generated
039     * through the MakeLDIF utility.
040     */
041    public interface EntryWriter
042    {
043      /**
044       * Writes the provided entry to the appropriate target.
045       *
046       * @param  entry  The entry to be written.
047       *
048       * @return  <CODE>true</CODE> if the entry writer will accept additional
049       *          entries, or <CODE>false</CODE> if no more entries should be
050       *         written.
051       *
052       * @throws  IOException  If a problem occurs while writing the entry to its
053       *                       intended destination.
054       *
055       * @throws  MakeLDIFException  If some other problem occurs.
056       */
057      public boolean writeEntry(Entry entry)
058             throws IOException, MakeLDIFException;
059    
060    
061    
062      /**
063       * Notifies the entry writer that no more entries will be provided and that
064       * any associated cleanup may be performed.
065       */
066      public void closeEntryWriter();
067    }
068