spoon.reflect.declaration.CtProvidedService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spoon-core Show documentation

Spoon is a tool for meta-programming, analysis and transformation of Java programs.

There is a newer version: 11.1.1-beta-14

/*
 * SPDX-License-Identifier: (MIT OR CECILL-C)
 *
 * Copyright (C) 2006-2023 INRIA and contributors
 *
 * Spoon is available either under the terms of the MIT License (see LICENSE-MIT.txt) or the Cecill-C License (see LICENSE-CECILL-C.txt). You as the user are entitled to choose the terms under which to adopt Spoon.
 */
package spoon.reflect.declaration;

import spoon.reflect.annotations.PropertyGetter;
import spoon.reflect.annotations.PropertySetter;
import spoon.reflect.path.CtRole;
import spoon.reflect.reference.CtTypeReference;

import java.util.List;

/**
 * Represents a provided service in a {@link CtModule}.
 * The provides directive specifies a service for which the with clause specifies one or more service providers to java.util.ServiceLoader.
 * The service must be a class type, an interface type, or an annotation type. It is a compile-time error if a provides directive specifies an enum type as the service.
 *
 * The service may be declared in the current module or in another module. If the service is not declared in the current module, then the service must be accessible to code in the current module, or a compile-time error occurs.
 * Every service provider must be a class type or an interface type, that is public, and that is top level or nested static, or a compile-time error occurs.
 * Every service provider must be declared in the current module, or a compile-time error occurs.
 *
 * It is a compile-time error if more than one provides directive in a module declaration specifies the same service.
 * It is a compile-time error if the with clause of a given provides directive specifies the same service provider more than once.
 *
 * Example:
 *  *     provides com.example.foo.spi.Itf with com.example.foo.Impl;
 * 
 */
public interface CtProvidedService extends CtModuleDirective {

	@PropertyGetter(role = CtRole.SERVICE_TYPE)
	CtTypeReference getServiceType();

	@PropertySetter(role = CtRole.SERVICE_TYPE)
	 T setServiceType(CtTypeReference providingType);

	@PropertyGetter(role = CtRole.IMPLEMENTATION_TYPE)
	List getImplementationTypes();

	@PropertySetter(role = CtRole.IMPLEMENTATION_TYPE)
	 T setImplementationTypes(List usedTypes);

	@PropertySetter(role = CtRole.IMPLEMENTATION_TYPE)
	 T addImplementationType(CtTypeReference usedType);

	@Override
	CtProvidedService clone();
}