org.glassfish.hk2.api.FactoryDescriptors Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2015 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 org.glassfish.hk2.api;
/**
* This is a convenience class that links together the factory descriptor as a factory
* for another type and the factory as a service itself. It is not required to use
* this helper to register a factory, as the individual descriptors can be registered
* with the system independently.
*
* @author jwells
*
*/
public interface FactoryDescriptors {
/**
* This returns the factory as a service itself. The advertised
* contracts must contain the implementation class of the factory and
* the {@link Factory}. The descriptor type must be {@link DescriptorType#CLASS}
* since this descriptor is describing the factory itself.
*
* @return The factory as a service itself
*/
public Descriptor getFactoryAsAService();
/**
* This returns the factory as a factory for some other type. The
* implementation class should contain the implementation class
* of the factory service. If the implementation class returned from
* this does not match the implementation class returned from getFactoryAsAService
* an error will occur. The contracts, name and qualifiers should represent
* the type returned from the provide method of the factory. The descriptor
* type must be {@link DescriptorType#PROVIDE_METHOD} since this descriptor is
* describing the factory as a factory, not as a service.
*
* @return The factory descriptor as a factory
*/
public Descriptor getFactoryAsAFactory();
}