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 2014 ForgeRock AS.
015 */
016
017package org.forgerock.openig.heap;
018
019/**
020 * Builds {@link Heaplet} instances.
021 * A {@link HeapletFactory} can manage multiple Heaplet types.
022 */
023public interface HeapletFactory {
024
025    /**
026     * Returns a new {@link Heaplet} instance that know how to build the given {@literal type}.
027     *
028     * @param type
029     *         the type that the created heaplet must support.
030     * @return a new {@link Heaplet} instance that know how to build the given {@literal type}, may return {@code null}
031     * if the given type is not supported by this factory.
032     */
033    Heaplet newInstance(final Class<?> type);
034}