Overview

A segment of a PropertyPath, which includes the name of the property and a 0-based index into this property.

If the property index is not set to PropertyPath.PathSegment.NON_REPEATED_CARDINALITY, this represents a schema property with the "repeated" cardinality, or a path like "foo[1]". Otherwise, this represents a schema property that could have any cardinality, or a path like "foo".

Summary

Fields

A marker variable to signify that a PathSegment represents a schema property that isn't indexed into. The value is chosen to be invalid if used as an array index.

Methods

Creation method that accepts and validates both a property name and the index into the property.

The property name may not be blank. It also may not contain square brackets or dots, as they are control characters in property paths. The index into the property may not be negative, unless it is PropertyPath.PathSegment.NON_REPEATED_CARDINALITY, as these are invalid array indices.

Parameters:

propertyName: the name of the property
propertyIndex: the index into the property

Returns:

A new PathSegment

Creation method that accepts and validates a property name

The property index is set to PropertyPath.PathSegment.NON_REPEATED_CARDINALITY

Parameters:

propertyName: the name of the property

Returns:

A new PathSegment

Returns the name of the property.

Returns the index into the property, or PropertyPath.PathSegment.NON_REPEATED_CARDINALITY if this does not represent a PathSegment with an index.

Returns a path representing a PathSegment, either "foo" or "foo[1]"