View Javadoc
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  package org.apache.commons.weaver.lifecycle;
20  
21  import java.lang.annotation.Documented;
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   * Defines token classes corresponding to the elements of the {@link WeaveLifecycle}.
29   *
30   * @since 1.2
31   */
32  public class WeaveLifecycleToken {
33      /**
34       * Declares the association between a {@link WeaveLifecycleToken} and an element of the {@link WeaveLifecycle}.
35       */
36      @Documented
37      @Retention(RetentionPolicy.RUNTIME)
38      @Target(ElementType.TYPE)
39      public @interface Represents {
40          /**
41           * The {@link WeaveLifecycle} stage represented by the annotated {@link WeaveLifecycleToken} type.
42           * @return {@link WeaveLifecycle}
43           */
44          WeaveLifecycle value();
45      }
46  
47      /**
48       * Represents {@link WeaveLifecycle#CLEAN}.
49       */
50      @Represents(WeaveLifecycle.CLEAN)
51      public static final class Clean extends WeaveLifecycleToken {
52      }
53  
54      /**
55       * Represents {@link WeaveLifecycle#WEAVE}.
56       */
57      @Represents(WeaveLifecycle.WEAVE)
58      public static final class Weave extends WeaveLifecycleToken {
59      }
60  }