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 legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2006-2009 Sun Microsystems, Inc.
025 *      Portions Copyright 2015 ForgeRock AS
026 */
027package org.opends.server.tools.makeldif;
028
029
030
031import java.io.IOException;
032
033
034
035/**
036 * This interface defines a method that may be used to write entries generated
037 * through the MakeLDIF utility.
038 */
039public interface EntryWriter
040{
041  /**
042   * Writes the provided entry to the appropriate target.
043   *
044   * @param  entry  The entry to be written.
045   *
046   * @return  <CODE>true</CODE> if the entry writer will accept additional
047   *          entries, or <CODE>false</CODE> if no more entries should be
048   *         written.
049   *
050   * @throws  IOException  If a problem occurs while writing the entry to its
051   *                       intended destination.
052   *
053   * @throws  MakeLDIFException  If some other problem occurs.
054   */
055  boolean writeEntry(TemplateEntry entry)
056         throws IOException, MakeLDIFException;
057
058
059
060  /**
061   * Notifies the entry writer that no more entries will be provided and that
062   * any associated cleanup may be performed.
063   */
064  void closeEntryWriter();
065}
066