Skip to content

Commit

Permalink
javadoc: Order improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
sdelamo committed May 17, 2024
1 parent 8a365a9 commit f255128
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions core/src/main/java/io/micronaut/core/annotation/Order.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,23 @@
/**
* Annotation for objects that are ordered.
*
* <p>Order in a Micronaut application is important in multiple aspects including but note limited to:</p>
*
* <ul>
* <li>Controlling bean selection and prioritization</li>
* <li>Ordering injected {@link java.util.List} collections.</li>
* <li>Ordering AOP method interceptors</li>
* <li>Ordering HTTP filters</li>
* </ul>
*
* <p>This annotation can be used to control the order by specifying a numerical value
* that sorts components in the desired order</p>
*
* @author Sean Carroll
* @since 2.0
* @see io.micronaut.core.order.Ordered
* @see io.micronaut.core.order.Ordered#HIGHEST_PRECEDENCE
* @see io.micronaut.core.order.Ordered#LOWEST_PRECEDENCE
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
Expand Down

0 comments on commit f255128

Please sign in to comment.