001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2010 Sun Microsystems, Inc.
015 * Portions copyright 2012 ForgeRock AS.
016 */
017
018package org.forgerock.opendj.ldap;
019
020/**
021 * Entry factories are included with a set of {@code DecodeOptions} in order to
022 * allow application to control how {@code Entry} instances are created when
023 * decoding requests and responses.
024 *
025 * @see Entry
026 * @see DecodeOptions
027 */
028public interface EntryFactory {
029    /**
030     * Creates an empty entry using the provided distinguished name and no
031     * attributes.
032     *
033     * @param name
034     *            The distinguished name of the entry to be created.
035     * @return The new entry.
036     * @throws NullPointerException
037     *             If {@code name} was {@code null}.
038     */
039    Entry newEntry(DN name);
040}