| | |
| | | * (the "License"). You may not use this file except in compliance |
| | | * with the License. |
| | | * |
| | | * You can obtain a copy of the license at |
| | | * trunk/opendj3/legal-notices/CDDLv1_0.txt |
| | | * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt |
| | | * or http://forgerock.org/license/CDDLv1.0.html. |
| | | * See the License for the specific language governing permissions |
| | | * and limitations under the License. |
| | | * |
| | | * When distributing Covered Code, include this CDDL HEADER in each |
| | | * file and include the License file at |
| | | * trunk/opendj3/legal-notices/CDDLv1_0.txt. If applicable, |
| | | * add the following below this CDDL HEADER, with the fields enclosed |
| | | * by brackets "[]" replaced with your own identifying information: |
| | | * file and include the License file at legal-notices/CDDLv1_0.txt. |
| | | * If applicable, add the following below this CDDL HEADER, with the |
| | | * fields enclosed by brackets "[]" replaced with your own identifying |
| | | * information: |
| | | * Portions Copyright [yyyy] [name of copyright owner] |
| | | * |
| | | * CDDL HEADER END |
| | |
| | | |
| | | package org.forgerock.opendj.ldif; |
| | | |
| | | |
| | | |
| | | import java.io.Closeable; |
| | | import java.io.IOException; |
| | | import java.util.*; |
| | | import java.util.NoSuchElementException; |
| | | |
| | | import org.forgerock.opendj.ldap.Entry; |
| | | |
| | | |
| | | |
| | | /** |
| | | * An interface for reading entries from a data source, typically an LDIF file. |
| | | * <p> |
| | |
| | | * <li>Any synchronization limitations. |
| | | * </ul> |
| | | */ |
| | | public interface EntryReader extends Closeable |
| | | { |
| | | public interface EntryReader extends Closeable { |
| | | |
| | | /** |
| | | * Closes this entry reader if it is not already closed. Note that this method |
| | | * does not need to be called if a previous call of {@link #readEntry()} has |
| | | * returned {@code null}. |
| | | * |
| | | * @throws IOException |
| | | * If an unexpected IO error occurred while closing. |
| | | */ |
| | | @Override |
| | | void close() throws IOException; |
| | | /** |
| | | * Closes this entry reader if it is not already closed. Note that this |
| | | * method does not need to be called if a previous call of |
| | | * {@link #readEntry()} has returned {@code null}. |
| | | * |
| | | * @throws IOException |
| | | * If an unexpected IO error occurred while closing. |
| | | */ |
| | | @Override |
| | | void close() throws IOException; |
| | | |
| | | /** |
| | | * Returns {@code true} if this reader contains another entry, blocking if |
| | | * necessary until either the next entry is available or the end of the |
| | | * stream is reached. |
| | | * |
| | | * @return {@code true} if this reader contains another entry. |
| | | * @throws IOException |
| | | * If an unexpected IO error occurred. |
| | | */ |
| | | boolean hasNext() throws IOException; |
| | | |
| | | |
| | | /** |
| | | * Returns {@code true} if this reader contains another entry, blocking if |
| | | * necessary until either the next entry is available or the end of the stream |
| | | * is reached. |
| | | * |
| | | * @return {@code true} if this reader contains another entry. |
| | | * @throws IOException |
| | | * If an unexpected IO error occurred. |
| | | */ |
| | | boolean hasNext() throws IOException; |
| | | |
| | | |
| | | |
| | | /** |
| | | * Reads the next entry, blocking if necessary until an entry is available. |
| | | * |
| | | * @return The next entry. |
| | | * @throws IOException |
| | | * If an unexpected IO error occurred while reading the entry. |
| | | * @throws NoSuchElementException |
| | | * If this reader does not contain any more entries. |
| | | */ |
| | | Entry readEntry() throws IOException; |
| | | /** |
| | | * Reads the next entry, blocking if necessary until an entry is available. |
| | | * |
| | | * @return The next entry. |
| | | * @throws IOException |
| | | * If an unexpected IO error occurred while reading the entry. |
| | | * @throws NoSuchElementException |
| | | * If this reader does not contain any more entries. |
| | | */ |
| | | Entry readEntry() throws IOException; |
| | | } |