ValidatePathBuilder

Description

sealed class Tinman.Core.Validating.ValidatePathBuilder

Helper class for building ValidatePath objects.

After having created ValidatePathBuilder object with ValidatePath.Build, use the following methods to build a validation path:

Append¹:
Append another validation path.
Append³:
Append the path elements of another builder.
Context, Entry, Index, Member:
Add path elements to the builder.
Clear, Remove:
Remove path elements from the builder.
Path:
Build a ValidatePath for the current path elements.

Public / Methods

Append

_3 overloads

public method Append¹ → (1)

path ⁱⁿ : ValidatePath: [not-null]
The validation path to append.
returns → ValidatePathBuilder: this

Appends the given validation path.

public method Append² → (2)

path ⁱⁿ : ValidatePath: [not-null]
The validation path to append.
index ⁱⁿ : int32: [0..path.Length-1]
Index of the path element to append.
returns → ValidatePathBuilder: this

Appends a path element of the given validation path.

public method Append³ → (1)

path ⁱⁿ : ValidatePathBuilder: [not-null]
The validation path to append.
returns → ValidatePathBuilder: this

Appends the given validation path.

Clear

public method Clear → ()

returns → ValidatePathBuilder: this

Removes all path elements from the builder.

Context

public method Context → (1)

context ⁱⁿ : object: [not-null]
The context object.
returns → ValidatePathBuilder: this

Adds a path element of type ValidatePathElement.Context.

If the last path element specifies the same context object, this method returns without adding a new path element.

Entry

public method Entry → (1)

name ⁱⁿ : string: [not-empty]
The entry name.
returns → ValidatePathBuilder: this

Adds a path element of type ValidatePathElement.Entry.

Index

public method Index → (1)

index ⁱⁿ : int32: [>=0]
The element index.
returns → ValidatePathBuilder: this

Adds a path element of type ValidatePathElement.Index.

Member

public method Member → (1)

name ⁱⁿ : string: [not-empty]
The member name.
returns → ValidatePathBuilder: this

Adds a path element of type ValidatePathElement.Member.

Path

public method Path → ()

returns → ValidatePath: The built path, which will be ValidatePath.Empty iff Length is zero.

Builds a validation path from the current elements.

Remove

public method Remove → (2)

first ⁱⁿ : int32: [0..ValidatePathBuilder.Length]
Index of first path element to remove.
count ^opt : int32 = 1: [-1..ValidatePathBuilder.Length-first]
Number of path elements to remove. If negative, all remaining elements will be removed.
returns → ValidatePathBuilder: this

Removes elements from the path being built.

Public / Attributes

Length

public attribute Length → (get)

value : int32: [>=0]
The number of path elements.

Returns the length of the path being built, in path elements.