Class QueryStringParameterScopeParser

Namespace

JsonApiDotNetCore.Queries.Parsing

Assembly

JsonApiDotNetCore.dll

Parser for the JSON:API 'sort' and 'filter' query string parameter names, which indicate the scope their query string parameter value applies to. The value consists of an optional relationship chain ending in a to-many relationship, surrounded by brackets.

[PublicAPI]
public class QueryStringParameterScopeParser : QueryExpressionParser, IQueryStringParameterScopeParser

Inheritance

object

QueryExpressionParser

QueryStringParameterScopeParser

Implements

IQueryStringParameterScopeParser

Inherited Members

QueryExpressionParser.TokenStack

QueryExpressionParser.Source

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()

QueryExpressionParser.ParseCommaSeparatedSequenceOfRelationshipChains(ResourceType)

QueryExpressionParser.ParseRelationshipChainEndingInToMany(ResourceType, string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Parse(string, ResourceType)

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

public QueryStringParameterScopeExpression Parse(string source, ResourceType resourceType)

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.

Returns

QueryStringParameterScopeExpression

ParseQueryStringParameterScope(ResourceType)

protected virtual QueryStringParameterScopeExpression ParseQueryStringParameterScope(ResourceType resourceType)

Parameters

resourceType ResourceType

Returns

QueryStringParameterScopeExpression