com.sun.enterprise.module.InhabitantsDescriptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hk2-core Show documentation
There is a newer version: 1.6.9
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010-2011 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package com.sun.enterprise.module;

import com.sun.hk2.component.InhabitantParser;
import com.sun.hk2.component.KeyValuePairParser;

import java.io.IOException;

/**
 * Inhabitants Descriptor is an abstraction on how the inhabitants are
 * represented in a module. It might be a file, or it might rely on some
 * other mechanism like introspection to get the list of inhabitant.
 *
 * @author Jerome Dochez
 */
public interface InhabitantsDescriptor {

    /**
     * Return the unique identifier
     * @return unique id
     */
    String getSystemId();

    /**
     * Creates an {@see InhabitantsScanner} instance capable of returning the
     * metadata for all inhabitant.
     *
     * @return the scanner for inhabitant metadata
     * @throws IOException if the scanner create fails initialization
     */
    Iterable createScanner() throws IOException;
}