de.fraunhofer.iese.ind2uce.reactive.common.EventSpecification Maven / Gradle / Ivy

Go to download
/*-
 * =================================LICENSE_START=================================
 * IND2UCE
 * %%
 * Copyright (C) 2016 Fraunhofer IESE (www.iese.fraunhofer.de)
 * %%
 * 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.
 * =================================LICENSE_END=================================
 */

package de.fraunhofer.iese.ind2uce.reactive.common;

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

/**
 * The description of an event which is required to identify that event in
 * IND2UCE. It includes three fields {@link #scope()} and {@link #action()}
 * which are part of the event id. Created by chattapa on 10/28/16.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({
    ElementType.METHOD
})
public @interface EventSpecification {
  /**
   * The event action.
   *
   * @return the action
   */
  String action();

  /***
   * the event description.
   *
   * @return the description
   */
  String description() default "";

  /**
   * The event scope.
   *
   * @return the scope
   */
  String scope();
}