Class PropertyPath

Represents a path to a given property within an object graph such as an item within a template.

Inheritance

Object

Stack<String>

PropertyPath

Implements

IReadOnlyCollection<String>

IEnumerable<String>

ICollection

IEnumerable

IEquatable<PropertyPath>

Inherited Members

Stack<String>.Clear()

Stack<String>.Contains(String)

Stack<String>.CopyTo(String[], Int32)

Stack<String>.GetEnumerator()

Stack<String>.Peek()

Stack<String>.Pop()

Stack<String>.Push(String)

Stack<String>.IEnumerable<String>.GetEnumerator()

Stack<String>.ICollection.CopyTo(Array, Int32)

Stack<String>.IEnumerable.GetEnumerator()

Stack<String>.ToArray()

Stack<String>.TrimExcess()

Stack<String>.Count

Stack<String>.ICollection.IsSynchronized

Stack<String>.ICollection.SyncRoot

Object.Equals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Firefly.CloudFormationParser.Utils

Assembly: Firefly.CloudFormationParser.dll

Syntax

public class PropertyPath : Stack<string>, IReadOnlyCollection<string>, IEnumerable<string>, ICollection, IEnumerable, IEquatable<PropertyPath>

Constructors

PropertyPath()

Initializes a new instance of the PropertyPath class.

Declaration

public PropertyPath()

PropertyPath(IEnumerable<String>)

Initializes a new instance of the PropertyPath class.

Declaration

public PropertyPath(IEnumerable<string> pathComponents)

Parameters

Type	Name	Description
IEnumerable<String>	pathComponents	The path components.

Properties

Depth

Gets the path depth (number of path components on the stack).

Declaration

public int Depth { get; }

Property Value

Type	Description
Int32	The depth.

Path

Gets the current path.

Declaration

public string Path { get; }

Property Value

Type	Description
String	The path.

Methods

Clone()

Clones this instance.

Declaration

public PropertyPath Clone()

Returns

Type	Description
PropertyPath	A new PropertyPath with the current stack of elements

Equals(PropertyPath)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(PropertyPath other)

Parameters

Type	Name	Description
PropertyPath	other	An object to compare with this object.

Returns

Type	Description
Boolean	true if the current object is equal to the other parameter; otherwise, false.

Equals(Object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	The object to compare with the current object.

Returns

Type	Description
Boolean	true if the specified object is equal to the current object; otherwise, false.

Overrides

Object.Equals(Object)

GetHashCode()

Returns a hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides

Object.GetHashCode()

ToJsonPath()

Converts this path to a JSON path suitable for use with SelectToken

Declaration

public string ToJsonPath()

Returns

Type	Description
String	JSON path

See Also

Querying JSON with SelectToken

Operators

Equality(PropertyPath, PropertyPath)

Implements the operator ==.

Declaration

public static bool operator ==(PropertyPath left, PropertyPath right)

Parameters

Type	Name	Description
PropertyPath	left	The left.
PropertyPath	right	The right.

Returns

Type	Description
Boolean	The result of the operator.

Inequality(PropertyPath, PropertyPath)

Implements the operator !=.

Declaration

public static bool operator !=(PropertyPath left, PropertyPath right)

Parameters

Type	Name	Description
PropertyPath	left	The left.
PropertyPath	right	The right.

Returns

Type	Description
Boolean	The result of the operator.

Implements

System.Collections.Generic.IReadOnlyCollection<T>

System.Collections.Generic.IEnumerable<T>

System.Collections.ICollection

System.Collections.IEnumerable

System.IEquatable<T>