annotation library
Jetleaf Annotation sub-library
This sub-library provides core annotations and resolver helpers
for the jetleaf_web package.
Importing package:jetleaf_web/annotation.dart exposes annotations
for request mapping, request parameters, and resolver contexts,
along with default resolver support.
These annotations enable declarative configuration of request handling, parameter binding, and component resolution.
Classes
- Catch
- Annotation that marks a method or class as an exception handler.
- Controller
- Controller annotation for Jet View controllers
- ControllerAdvice
- Marks a class as a controller advice within the JetLeaf framework, enabling centralized handling of cross-cutting web concerns such as:
- CookieValue
- Binds the value of a cookie from the HTTP request to a method parameter.
- CookieValueResolver
- Resolves method parameters annotated with CookieValue by extracting values from HTTP cookies in the request.
- CrossOrigin
- Configures Cross-Origin Resource Sharing (CORS) for a specific controller method, allowing controlled access from other origins.
- DefaultResolverContext
- Default implementation of ResolverContext backed by HttpMessageConverters.
- DeleteMapping
-
Shorthand annotation for a
DELETEHTTP method mapping on a controller method. - ExceptionHandler
- Annotation used to mark a method as an exception handler within a controller.
- GetMapping
-
Shorthand annotation for a
GETHTTP method mapping on a controller method. - MatrixVariable
- Binds a matrix variable from a specific path segment of the URI to a method parameter.
- MatrixVariableResolver
- Resolves method parameters annotated with MatrixVariable by extracting matrix variables from URI path segments.
- PatchMapping
-
Shorthand annotation for a
PATCHHTTP method mapping on a controller method. - PathVariable
- Binds a path variable from the URI template to a method parameter.
- PathVariableResolver
- Resolves method parameters annotated with PathVariable by extracting values from URI template variables.
- PostMapping
-
Shorthand annotation for a
POSTHTTP method mapping on a controller method. - Produces
- Marks a controller or handler method with the media types that it can produce in the response.
- PutMapping
-
Shorthand annotation for a
PUTHTTP method mapping on a controller method. - RequestAttribute
- Binds a request-scoped attribute to a method parameter.
- RequestAttributeResolver
- Resolves method parameters annotated with RequestAttribute by extracting values from request-scoped attributes.
- RequestBody
- Marks a method parameter to be bound to the HTTP request body.
- RequestBodyResolver
-
Resolves method parameters annotated with
@RequestBody. - RequestHeader
- Binds the value of a specific HTTP request header to a method parameter.
- RequestHeaderResolver
- Resolves method parameters annotated with RequestHeader by extracting values from HTTP request headers.
- RequestMapping
- Maps an HTTP request to a specific controller method or class within JetLeaf.
- RequestParam
- Binds a query parameter from the HTTP request URI to a method parameter.
- RequestParameter
- Base annotation for binding HTTP request elements to method parameters.
- RequestParamResolver
- Resolves method parameters annotated with RequestParam by extracting values from HTTP request parameters (query string or form data).
- RequestPart
- Binds a multipart/form-data request part to a method parameter.
- RequestPartResolver
-
Resolves method parameters annotated with
@RequestPartin multipart requests. - ResolvedBy
- A metadata annotation that associates parameter resolver implementations with annotation classes for web request parameter resolution.
- Resolver
- The core interface for resolving method parameter values from HTTP request context.
- ResolverContext
- Defines a strategy interface for locating appropriate HttpMessageConverters capable of reading or writing specific Dart types within a given media type context.
- ResponseStatus
- Annotation used to mark a controller class or method with a specific HTTP status.
- RestController
- Marks a class as a REST controller within the JetLeaf framework.
- RestControllerAdvice
- Specialized variant of ControllerAdvice for REST controllers that produce structured responses (e.g., JSON or XML).
- SessionAttribute
- Binds a session-scoped attribute to a controller method parameter.
- SessionAttributeResolver
- Resolves method parameters annotated with SessionAttribute by extracting values from HTTP session attributes.
- WebView
- Marks a class as a web view component specialized for rendering HTML, CSS, or JavaScript content.