com.thoughtworks.go.plugin.api.annotation.UnLoad 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.annotation;

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

/**
 * Annotation that marks a method to be called when a plugin is unloaded.
 * 
 * Intended for use by plugin developers to mark a method of an
 * extension implementation to be called during plugin unload time.
 * 
 * The semantics of the method marked with this annotation is as follows.
 * 
 *     There should atmost one method in the implementation that should have this annotation.
 *     The method should be public, non-static.
 *     The method should take only one parameter- {@link com.thoughtworks.go.plugin.api.info.PluginContext}. Return values will be ignored.
 *     This annotation will not be inherited along with the method.
 * 
 *
 * The framework performs the validation of the semantics mentioned above during the plugin load time - before executing the
 * method marked with {@link Load} annotation. But the callback to this method is only done during the plugin unload time.
 * In summary, semantics checks are done at the plugin load and invocation done during the plugin unload.
 *
 * Please refer to the Go Plugin documentation for more details.
 *
 * @see Go Plugin Documentation
 * @see com.thoughtworks.go.plugin.api.info.PluginContext
 * @see Load
 *
 * @author Go Team
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface UnLoad {
}