org.opensearch.common.inject.assistedinject.AssistedInject Maven / Gradle / Ivy
Show all versions of opensearch Show documentation
/*
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* Copyright (C) 2007 Google Inc.
*
* 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.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/
package org.opensearch.common.inject.assistedinject;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.CONSTRUCTOR;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Constructors annotated with {@code @AssistedInject} indicate that they can be instantiated by
* the {@link FactoryProvider}. Each constructor must exactly match one corresponding factory method
* within the factory interface.
*
* Constructor parameters must be either supplied by the factory interface and marked with
* @Assisted, or they must be injectable.
*
* @author [email protected] (Jerome Mourits)
* @author [email protected] (Jesse Wilson)
* @deprecated {@link FactoryProvider} now works better with the standard {@literal @Inject}
* annotation. When using that annotation, parameters are matched by name and type rather than
* by position. In addition, values that use the standard {@literal @Inject} constructor
* annotation are eligible for method interception.
*
* @opensearch.internal
*/
@Target({ CONSTRUCTOR })
@Retention(RUNTIME)
@Deprecated
public @interface AssistedInject {
}