OnExtendedStateChanged.java

/*
 * Copyright 2015-2016 the original author or authors.
 *
 * 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.springframework.statemachine.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.Map;

import org.springframework.messaging.Message;
import org.springframework.statemachine.ExtendedState;
import org.springframework.statemachine.StateMachine;

/**
 * Indicates that a method is candidate to be called when {@link ExtendedState}
 * is changed.
 * <p>
 * A method annotated with @OnExtendedStateChanged may accept a parameter of type
 * {@link ExtendedState}, {@link Map} if map argument itself is annotated
 * with {@link EventHeaders}, {@link StateMachine}, {@link Message} or {@link Exception}.
 * <p>
 * Return value can be anything and is effectively discarded.
 *
 * @author Janne Valkealahti
 *
 */
@Target({ ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface OnExtendedStateChanged {

	/**
	 * The extended state variable keys.
	 *
	 * @return The extended state variable keys
	 */
	String[] key() default {};

}