clarified applicability of @Order
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2002-2006 the original author or authors.
|
||||
* Copyright 2002-2009 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@@ -24,14 +24,18 @@ import java.lang.annotation.Target;
|
||||
import org.springframework.core.Ordered;
|
||||
|
||||
/**
|
||||
* Annotation to define ordering.
|
||||
* Annotation that defines ordering. The value is optional, and represents order value
|
||||
* as defined in the {@link Ordered} interface. Lower values have higher priority.
|
||||
* The default value is <code>Ordered.LOWEST_PRECEDENCE</code>, indicating
|
||||
* lowest priority (losing to any other specified order value).
|
||||
*
|
||||
* <p><b>NOTE:</b> Annotation-based ordering is supported for specific kinds of
|
||||
* components only, e.g. for annotation-based AspectJ aspects. Spring container
|
||||
* strategies, on the other hand, are typically based on the {@link Ordered}
|
||||
* interface in order to allow for configurable ordering of each <i>instance</i>.
|
||||
*
|
||||
* <p>Value is optional, and represents order value as defined
|
||||
* in the Ordered interface. Lower values have higher priority.
|
||||
* Default value is <code>Integer.MAX_VALUE</code>, indicating lowest
|
||||
* priority (losing to any other specified order value).
|
||||
*
|
||||
* @author Rod Johnson
|
||||
* @author Juergen Hoeller
|
||||
* @since 2.0
|
||||
* @see org.springframework.core.Ordered
|
||||
* @see AnnotationAwareOrderComparator
|
||||
@@ -40,6 +44,10 @@ import org.springframework.core.Ordered;
|
||||
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
|
||||
public @interface Order {
|
||||
|
||||
/**
|
||||
* The order value. Default is {@link Ordered#LOWEST_PRECEDENCE}.
|
||||
* @see Ordered#getOrder()
|
||||
*/
|
||||
int value() default Ordered.LOWEST_PRECEDENCE;
|
||||
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user