org.jboss.weld.inject.WeldInstance Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2016, Red Hat, Inc., and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jboss.weld.inject;
import java.lang.annotation.Annotation;
import javax.enterprise.inject.AmbiguousResolutionException;
import javax.enterprise.inject.Instance;
import javax.enterprise.inject.UnsatisfiedResolutionException;
import javax.enterprise.inject.spi.Bean;
import javax.enterprise.util.TypeLiteral;
/**
* An enhanced version of {@link Instance}.
*
* @author Martin Kouba
* @seeIssue WELD-2151
* @param
*/
public interface WeldInstance extends Instance {
/**
* Obtains a contextual reference handler for the bean that has the required type and required qualifiers and is eligible for injection.
*
* Note that each invocation of this method results in a separate {@link Instance#get()} invocation.
*
* @return a new handler
* @throws UnsatisfiedResolutionException
* @throws AmbiguousResolutionException
*/
Handler getHandler();
/**
*
* @return true if satisfied and not ambiguous, false otherwise
* @see #isAmbiguous()
* @see #isUnsatisfied()
*/
boolean isResolvable();
/**
* Allows to iterate over contextual reference handlers for all the beans that have the required type and required qualifiers and are eligible for
* injection.
*
* Note that the returned {@link Iterable} is stateless and so each {@link Iterable#iterator()} produces a new set of handlers.
*
* @return an iterable to iterate over the handlers
*/
Iterable> handlers();
@Override
WeldInstance select(Annotation... qualifiers);
@Override
WeldInstance select(Class subtype, Annotation... qualifiers);
@Override
WeldInstance select(TypeLiteral subtype, Annotation... qualifiers);
/**
* A contextual reference handler. Not suitable for sharing between threads.
*
* Holds the contextual reference, allows to inspect the metadata of the relevant bean and also to destroy the underlying contextual instance.
*
* @author Martin Kouba
*
* @param
*/
public interface Handler extends AutoCloseable {
/**
*
* @return the contextual reference
* @see Instance#get()
*/
T get();
/**
*
* @return the bean metadata
*/
Bean getBean();
/**
* Destroy the contextual instance.
*
* It's a no-op if called multiple times or if the producing {@link WeldInstance} is destroyed already.
*
* @see Instance#destroy(Object)
*/
void destroy();
/**
* Delegates to {@link #destroy()}.
*/
@Override
void close();
}
}