|
1 | 1 | /*
|
2 |
| - * Copyright 2002-2006 the original author or authors. |
| 2 | + * Copyright 2002-2009 the original author or authors. |
3 | 3 | *
|
4 | 4 | * Licensed under the Apache License, Version 2.0 (the "License");
|
5 | 5 | * you may not use this file except in compliance with the License.
|
|
24 | 24 | import org.springframework.core.Ordered;
|
25 | 25 |
|
26 | 26 | /**
|
27 |
| - * Annotation to define ordering. |
| 27 | + * Annotation that defines ordering. The value is optional, and represents order value |
| 28 | + * as defined in the {@link Ordered} interface. Lower values have higher priority. |
| 29 | + * The default value is <code>Ordered.LOWEST_PRECEDENCE</code>, indicating |
| 30 | + * lowest priority (losing to any other specified order value). |
| 31 | + * |
| 32 | + * <p><b>NOTE:</b> Annotation-based ordering is supported for specific kinds of |
| 33 | + * components only, e.g. for annotation-based AspectJ aspects. Spring container |
| 34 | + * strategies, on the other hand, are typically based on the {@link Ordered} |
| 35 | + * interface in order to allow for configurable ordering of each <i>instance</i>. |
28 | 36 | *
|
29 |
| - * <p>Value is optional, and represents order value as defined |
30 |
| - * in the Ordered interface. Lower values have higher priority. |
31 |
| - * Default value is <code>Integer.MAX_VALUE</code>, indicating lowest |
32 |
| - * priority (losing to any other specified order value). |
33 |
| - * |
34 | 37 | * @author Rod Johnson
|
| 38 | + * @author Juergen Hoeller |
35 | 39 | * @since 2.0
|
36 | 40 | * @see org.springframework.core.Ordered
|
37 | 41 | * @see AnnotationAwareOrderComparator
|
|
40 | 44 | @Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
|
41 | 45 | public @interface Order {
|
42 | 46 |
|
| 47 | + /** |
| 48 | + * The order value. Default is {@link Ordered#LOWEST_PRECEDENCE}. |
| 49 | + * @see Ordered#getOrder() |
| 50 | + */ |
43 | 51 | int value() default Ordered.LOWEST_PRECEDENCE;
|
44 | 52 |
|
45 | 53 | }
|
0 commit comments