org.metafacture.framework.FluxCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of metafacture-framework Show documentation

The interfaces implemented by Metafacture modules

There is a newer version: 6.2.0

Show newest version

/*
 * Copyright 2016 Christoph Böhme
 *
 * 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 org.metafacture.framework;

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

/**
 * Sets the name of the flux command which is implemented by the annotated
 * class. Annotated classes must implement at least one of the interfaces
 * extending {@link org.metafacture.framework.Receiver Receiver}.
 *
 * @author Christoph Böhme
 * @since 3.1.0
 *
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface FluxCommand {

	/**
	 * Returns the Flux command name.
	 *
	 * @return Flux command name
	 */
	String value();

}