1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.mina.statemachine.annotation;
21
22 import java.lang.annotation.ElementType;
23 import java.lang.annotation.Retention;
24 import java.lang.annotation.RetentionPolicy;
25 import java.lang.annotation.Target;
26
27 /**
28 * Annotation used to define the states in a state machine. Only applies to
29 * <code>static final String</code> fields. The value of the string will be used
30 * as state id.
31 *
32 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
33 */
34 @Retention(RetentionPolicy.RUNTIME)
35 @Target(ElementType.FIELD)
36 public @interface State {
37 public static final String ROOT = "__root__";
38
39 /**
40 * Sets the id of the parent state. The default is no parent.
41 *
42 * @return the id of the parent state
43 */
44 String value() default ROOT;
45 }