Specifies a matchable route path.
Contains RouteSegment
s for each path segment. This class is used internally by Router.
- Mixes-in
- APIDocumentable
Static Methods
-
specificationsForRoutePattern(
String routePattern) → List<RouteSpecification>
Constructors
- RouteSpecification(String patternString)
-
Creates a new RouteSpecification from a
String
.
Properties
- controller → RequestController
-
A reference back to the RequestController to be used when this specification is matched.
read / write - segments → List<RouteSegment>
-
A list of this specification's
RouteSegment
s.read / write - variableNames → List<String>
-
A list of all variables in this route.
read / write - documentableChild → APIDocumentable
-
Returns the next documentable object in a chain of documentable objects.
read-only, inherited - hashCode → int
-
The hash code for this object.
read-only, inherited - runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Operators
-
operator ==(
other) → bool -
The equality operator.
inherited
Methods
-
documentPaths(
PackagePathResolver resolver) → List<APIPath> -
Returns all
APIPath
objects this instance knows about. -
toString(
) → String -
Returns a string representation of this object.
-
documentAPI(
PackagePathResolver resolver) → APIDocument -
Returns an entire APIDocument describing an OpenAPI specification.
inherited -
documentOperations(
PackagePathResolver resolver) → List<APIOperation> -
Returns all APIOperations this object knows about.
inherited -
documentRequestBodyForOperation(
APIOperation operation) → APIRequestBody -
Returns all APIRequestBodys for
operation
.inherited -
documentResponsesForOperation(
APIOperation operation) → List<APIResponse> -
Returns all APIResponses for
operation
.inherited -
documentSecuritySchemes(
PackagePathResolver resolver) → Map<String, APISecurityScheme> -
Returns all APISecuritySchemes this instance knows about.
inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited