Class QueryStringParameterScopeParser

Namespace

JsonApiDotNetCore.Queries.Parsing

Assembly

JsonApiDotNetCore.dll

Parses the JSON:API 'sort' and 'filter' query string parameter names, which contain a resource field chain that indicates the scope its query string parameter value applies to.

[PublicAPI]
public class QueryStringParameterScopeParser : QueryExpressionParser, IQueryStringParameterScopeParser

Inheritance

object

QueryExpressionParser

QueryStringParameterScopeParser

Implements

IQueryStringParameterScopeParser

Inherited Members

QueryExpressionParser.TokenStack

QueryExpressionParser.ValidateField(ResourceFieldAttribute, int)

QueryExpressionParser.Tokenize(string)

QueryExpressionParser.ParseFieldChain(FieldChainPattern, FieldChainPatternMatchOptions, ResourceType, string)

QueryExpressionParser.EatText(string)

QueryExpressionParser.EatSingleCharacterToken(TokenKind)

QueryExpressionParser.GetNextTokenPositionOrEnd()

QueryExpressionParser.GetRelativePositionOfLastFieldInChain(ResourceFieldChainExpression)

QueryExpressionParser.AssertTokenStackIsEmpty()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Parse(string, ResourceType, FieldChainPattern, FieldChainPatternMatchOptions)

Parses the specified source into a QueryStringParameterScopeExpression. Throws a QueryParseException if the input is invalid.

public QueryStringParameterScopeExpression Parse(string source, ResourceType resourceType, FieldChainPattern pattern, FieldChainPatternMatchOptions options)

Parameters

source string

The source text to read from.

resourceType ResourceType

The resource type used to lookup JSON:API fields that are referenced in source.

pattern FieldChainPattern

The pattern that the field chain in source must match.

options FieldChainPatternMatchOptions

The match options for pattern.

Returns

QueryStringParameterScopeExpression

ParseQueryStringParameterScope(ResourceType, FieldChainPattern, FieldChainPatternMatchOptions)

protected virtual QueryStringParameterScopeExpression ParseQueryStringParameterScope(ResourceType resourceType, FieldChainPattern pattern, FieldChainPatternMatchOptions options)

Parameters

resourceType ResourceType

pattern FieldChainPattern

options FieldChainPatternMatchOptions

Returns

QueryStringParameterScopeExpression