001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements. See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership. The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License. You may obtain a copy of the License at
009 *
010 * http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied. See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.commons.weaver.lifecycle;
020
021import java.lang.annotation.Documented;
022import java.lang.annotation.ElementType;
023import java.lang.annotation.Retention;
024import java.lang.annotation.RetentionPolicy;
025import java.lang.annotation.Target;
026
027/**
028 * Defines token classes corresponding to the elements of the {@link WeaveLifecycle}.
029 *
030 * @since 1.2
031 */
032public class WeaveLifecycleToken {
033    /**
034     * Declares the association between a {@link WeaveLifecycleToken} and an element of the {@link WeaveLifecycle}.
035     */
036    @Documented
037    @Retention(RetentionPolicy.RUNTIME)
038    @Target(ElementType.TYPE)
039    public @interface Represents {
040        /**
041         * The {@link WeaveLifecycle} stage represented by the annotated {@link WeaveLifecycleToken} type.
042         */
043        WeaveLifecycle value();
044    }
045
046    /**
047     * Represents {@link WeaveLifecycle#CLEAN}.
048     */
049    @Represents(WeaveLifecycle.CLEAN)
050    public static final class Clean extends WeaveLifecycleToken {
051    }
052
053    /**
054     * Represents {@link WeaveLifecycle#WEAVE}.
055     */
056    @Represents(WeaveLifecycle.WEAVE)
057    public static final class Weave extends WeaveLifecycleToken {
058    }
059}