Top Description Inners Fields Constructors Methods
io.undertow.servlet.predicate

public Class DispatcherTypePredicate

extends Object
implements Predicate
Class Inheritance
All Implemented Interfaces
io.undertow.predicate.Predicate
Imports
java.util.HashMap, .HashSet, .Map, .Set, jakarta.servlet.DispatcherType, io.undertow.predicate.Predicate, .PredicateBuilder, io.undertow.server.HttpServerExchange, io.undertow.servlet.handlers.ServletRequestContext
Predicate that returns true if the dispatcher type matches the specified type.
Author
Stuart Douglas

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
DispatcherTypePredicate.Builder

Field Summary

Modifier and TypeField and Description
public static final DispatcherTypePredicate
ASYNC

private final DispatcherType
dispatcherType

public static final DispatcherTypePredicate
ERROR

public static final DispatcherTypePredicate
FORWARD

public static final DispatcherTypePredicate
INCLUDE

public static final DispatcherTypePredicate
REQUEST

Constructor Summary

AccessConstructor and Description
public
DispatcherTypePredicate(final DispatcherType dispatcherType)

Method Summary

Modifier and TypeMethod and Description
public boolean
resolve(final HttpServerExchange value)

Implements io.undertow.predicate.Predicate.resolve.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

ASYNCback to summary
public static final DispatcherTypePredicate ASYNC
dispatcherTypeback to summary
private final DispatcherType dispatcherType
ERRORback to summary
public static final DispatcherTypePredicate ERROR
FORWARDback to summary
public static final DispatcherTypePredicate FORWARD
INCLUDEback to summary
public static final DispatcherTypePredicate INCLUDE
REQUESTback to summary
public static final DispatcherTypePredicate REQUEST

Constructor Detail

DispatcherTypePredicateback to summary
public DispatcherTypePredicate(final DispatcherType dispatcherType)

Method Detail

resolveback to summary
public boolean resolve(final HttpServerExchange value)

Implements io.undertow.predicate.Predicate.resolve.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
io.undertow.servlet.predicate back to summary

public Class DispatcherTypePredicate.Builder

extends Object
implements PredicateBuilder
Class Inheritance
  • java.lang.Object
  • io.undertow.servlet.predicate.DispatcherTypePredicate.Builder
All Implemented Interfaces
io.undertow.predicate.PredicateBuilder

Constructor Summary

AccessConstructor and Description
public
Builder()

Method Summary

Modifier and TypeMethod and Description
public Predicate
build(final Map<String, Object>
The predicate config
config)

Implements io.undertow.predicate.PredicateBuilder.build.

Creates a predicate

public String
defaultParameter()

Implements io.undertow.predicate.PredicateBuilder.defaultParameter.

public String
name()

Implements io.undertow.predicate.PredicateBuilder.name.

The string representation of the predicate name.

public Map<String, Class<?>>
parameters()

Implements io.undertow.predicate.PredicateBuilder.parameters.

Returns a map of parameters and their types.

public Set<String>
requiredParameters()

Implements io.undertow.predicate.PredicateBuilder.requiredParameters.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Builderback to summary
public Builder()

Method Detail

buildback to summary
public Predicate build(final Map<String, Object> config)

Implements io.undertow.predicate.PredicateBuilder.build.

Doc from io.undertow.predicate.PredicateBuilder.build.

Creates a predicate

Parameters
config:Map<String, Object>

The predicate config

Returns:Predicate

The new predicate

Annotations
@Override
defaultParameterback to summary
public String defaultParameter()

Implements io.undertow.predicate.PredicateBuilder.defaultParameter.

Returns:String

Doc from io.undertow.predicate.PredicateBuilder.defaultParameter.

The default parameter name, or null if it does not have a default parameter

Annotations
@Override
nameback to summary
public String name()

Implements io.undertow.predicate.PredicateBuilder.name.

Doc from io.undertow.predicate.PredicateBuilder.name.

The string representation of the predicate name.

Returns:String

The predicate name

Annotations
@Override
parametersback to summary
public Map<String, Class<?>> parameters()

Implements io.undertow.predicate.PredicateBuilder.parameters.

Doc from io.undertow.predicate.PredicateBuilder.parameters.

Returns a map of parameters and their types.

Annotations
@Override
requiredParametersback to summary
public Set<String> requiredParameters()

Implements io.undertow.predicate.PredicateBuilder.requiredParameters.

Returns:Set<String>

Doc from io.undertow.predicate.PredicateBuilder.requiredParameters.

The required parameters

Annotations
@Override