FilterRoute (router 3.7.7 API)

All Superinterfaces:

io.micronaut.core.annotation.AnnotationMetadataProvider, io.micronaut.core.annotation.AnnotationSource, io.micronaut.http.filter.HttpFilterResolver.FilterEntry<io.micronaut.http.filter.HttpFilter>
```
public interface FilterRoute
extends io.micronaut.http.filter.HttpFilterResolver.FilterEntry<io.micronaut.http.filter.HttpFilter>
```
A filter route is a route that matches an HttpFilter.

Since:

1.0

Field Summary
- Fields inherited from interface io.micronaut.core.annotation.AnnotationSource
  EMPTY

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`io.micronaut.http.filter.HttpFilter`	`getFilter()`
`java.util.Optional<io.micronaut.http.filter.HttpFilter>`	`match(io.micronaut.http.HttpMethod method, java.net.URI uri)`	Matches the given path to this filter route.
`FilterRoute`	`methods(io.micronaut.http.HttpMethod... methods)`	Restrict the methods this filter route matches.
`FilterRoute`	`pattern(java.lang.String pattern)`	Add an addition pattern to this filter route.
`FilterRoute`	`patternStyle(io.micronaut.http.filter.FilterPatternStyle patternStyle)`	Sets the pattern style that this filter route matches.

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataProvider
findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotationMetadata, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

Methods inherited from interface io.micronaut.core.annotation.AnnotationSource
getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeDeclared

Methods inherited from interface io.micronaut.http.filter.HttpFilterResolver.FilterEntry
getFilterMethods, getPatterns, getPatternStyle, hasMethods, hasPatterns

- Method Detail
  - getFilter
```
io.micronaut.http.filter.HttpFilter getFilter()
```
    Specified by:
    
    getFilter in interface io.micronaut.http.filter.HttpFilterResolver.FilterEntry<io.micronaut.http.filter.HttpFilter>
    
    Returns:
    
    The filter for this FilterRoute
  - match
```
java.util.Optional<io.micronaut.http.filter.HttpFilter> match(io.micronaut.http.HttpMethod method,
                                                              java.net.URI uri)
```
    Matches the given path to this filter route.
    
    Parameters:
    
    method - The HTTP method
    
    uri - The URI
    
    Returns:
    
    An Optional of HttpFilter
  - pattern
```
FilterRoute pattern(java.lang.String pattern)
```
    Add an addition pattern to this filter route.
    
    Parameters:
    
    pattern - The pattern
    
    Returns:
    
    This route
  - methods
```
FilterRoute methods(io.micronaut.http.HttpMethod... methods)
```
    Restrict the methods this filter route matches.
    
    Parameters:
    
    methods - The methods
    
    Returns:
    
    This route
  - patternStyle
```
FilterRoute patternStyle(io.micronaut.http.filter.FilterPatternStyle patternStyle)
```
    Sets the pattern style that this filter route matches.
    
    Parameters:
    
    patternStyle - The pattern style
    
    Returns:
    
    This route