org.glassfish.hk2.api.Rank Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hk2-api Show documentation

${project.name}

There is a newer version: 4.0.0-M3

/*
 * Copyright (c) 2012, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.hk2.api;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * This annotation is used to provide the initial rank of
 * a service marked with {@link org.jvnet.hk2.annotations.Service}.
 * 
 * @author jwells
 *
 */
@Documented
@Inherited
@Retention(RUNTIME)
@Target( { TYPE, METHOD })
public @interface Rank {
    /**
     * The value this service should take initially
     * 
     * @return The value this service should take initially
     */
    public int value();
}