com.thoughtworks.go.plugin.api.GoPluginApiMarker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of go-plugin-api Show documentation

The APIs described here are needed for developing plugins for GoCD - A continuous delivery server

There is a newer version: 24.4.0

/*
 * Copyright 2020 ThoughtWorks, 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.
 */
package com.thoughtworks.go.plugin.api;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotation that marks a type as an extension point provided by Go.
 * 
 * This is intended for use by Go extension providers. The provider can mark
 * an interface or a class with this annotation to indicate to the plugin
 * framework that the interface or class will be implemented by a plugin.
 * 
 * The plugin framework would do required runtime setup so that
 * the interface classes are available to the plugin implementations.
 *
 * @author Go Team
 *
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface GoPluginApiMarker {
}