com.speedment.common.injector.annotation.ExecuteBefore Maven / Gradle / Ivy

Go to download
/**
 *
 * Copyright (c) 2006-2016, Speedment, Inc. All Rights Reserved.
 *
 * 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 com.speedment.common.injector.annotation;

import com.speedment.common.injector.State;

import java.lang.annotation.*;

/**
 * Annotes that the method should be executed as part of the
 * platform initialization. The annoted method can only take 
 * parameters with the @{@link Inject}-annotation.
 * 
 * This method must be executed before this component can be
 * considered to be in the specified state.
 * 
 * @author  Emil Forslund
 * @since   1.0.0
 * 
 * @see  Execute
 */
@Inherited
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ExecuteBefore {
    
    /**
     * The state before which this annoted method must be
     * executed.
     * 
     * @return  the state
     */
    State value();
}