org.glassfish.jersey.internal.inject.Injectee Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jersey-common Show documentation
Show all versions of jersey-common Show documentation
Jersey core common packages
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2017 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://oss.oracle.com/licenses/CDDL+GPL-1.1
* or 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 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.jersey.internal.inject;
import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Type;
import java.util.Set;
/**
* An Injectee represents the point of injection. It can be used by injection resolvers to discover all of the information
* available about the entity being injected into.
*/
public interface Injectee {
/**
* This is the required type of the injectee. The object that is injected into this point must be type-safe with regards to
* this type.
*
* @return The type that this injectee is expecting. Any object injected into this injection point must be type-safe with
* regards to this type.
*/
Type getRequiredType();
/**
* This is the set of required qualifiers for this injectee. All of these qualifiers must be present on the implementation
* class of the object that is injected into this injectee. Note that the fields of the annotation must also match.
*
* @return Will not return {@code null}, but may return an empty set. The set of all qualifiers that must match.
*/
Set getRequiredQualifiers();
/**
* If this Injectee is a constructor or method parameter, this will return the index of the parameter. If this
* {@code Injectee} is a field, this will return {@code -1}.
*
* @return the position of the parameter, or {@code -1} if this is a field.
*/
int getPosition();
/**
* Returns the parent class for this injectee. This is the class of the object that will be injected into. This field may
* return {@code null} if this is from a service lookup.
*
* @return The class of the object that will be injected into.
*/
Class getInjecteeClass();
/**
* If this Injectee is in a constructor this will return the constructor being injected into. If this Injectee is in a
* method this will return the method being injected into. If this injectee represents a field, this will return the field
* being injected into. This injectee may be neither in which case this will return {@code null}.
*
* @return The parent of the injectee, which may be {@code null}.
*/
AnnotatedElement getParent();
/**
* This method returns {@code true} if this injection point is annotated with VOptional. In this case if there is no
* definition for the injection point in the system it is allowable for the system to merely return {@code null}.
*
* @return {@code true} if the injection point is annotated with VOptional, {@code false} otherwise.
*/
boolean isOptional();
/**
* This method returns foreign descriptor of the current injectee that means that the DI provider is able to store its
* specific descriptor and that use it in the descriptor processing.
*
* @return DI specific foreign descriptor.
*/
ForeignDescriptor getInjecteeDescriptor();
/**
* This method returns scope in which the parent class is registered.
*
* @return scope annotation.
*/
Class getParentClassScope();
/**
* This method returns {@code true} if the injectee value is provided using {@link java.util.function.Supplier}.
*
* @return {@code true} if the injectee is a factory.
*/
boolean isFactory();
/**
* This method returns {@code true} if the injectee value is provided using {@link javax.inject.Provider}.
*
* @return {@code true} if the injectee is a provider.
*/
boolean isProvider();
}