org.glassfish.jersey.internal.inject.ForeignDescriptor Maven / Gradle / Ivy
Show all versions of jersey-common Show documentation
/*
* 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.util.function.Consumer;
/**
* The descriptor holder for an externally provided DI providers. Using this interface DI provider is able to provider his own
* descriptor which can be used and returned to the DI provider in further processing.
*
* This is useful in the case of caching where an algorithm is able to store and subsequently provide for an injection the already
* resolved descriptor of the same value.
*/
public interface ForeignDescriptor {
/**
* Returns an object that can be cast on the side of DI provider to his descriptor.
*
* @return DI provider's descriptor.
*/
Object get();
/**
* Disposes this instance. All the PerLookup objects that were created for this instance will be destroyed after this
* object has been destroyed.
*
* @param instance The instance to destroy.
*/
void dispose(Object instance);
/**
* Wraps incoming descriptor instance and provides a default implementation of {@link ForeignDescriptor}.
*
* @param descriptor incoming foreign descriptor.
* @return wrapped foreign descriptor.
*/
static ForeignDescriptor wrap(Object descriptor) {
return new ForeignDescriptorImpl(descriptor);
}
/**
* Wraps incoming descriptor instance and provides a default implementation of {@link ForeignDescriptor} along with a
* {@link Consumer} for a disposing an instance created using a given descriptor.
*
* @param descriptor incoming foreign descriptor.
* @param disposeInstance consumer which is able to dispose an instance created with the given descriptor.
* @return wrapped foreign descriptor.
*/
static ForeignDescriptor wrap(Object descriptor, Consumer