PathFeatures (hydra-pg 0.17.6 API)

java.lang.Object
- hydra.cypher.features.PathFeatures

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PathFeatures>
```
public class PathFeatures
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<PathFeatures>
```
Path functions only found in OpenCypher

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PathFeatures.Builder
A fluent builder for PathFeatures.

Field Summary

Fields
Modifier and Type	Field	Description
`static Name`	`SHORTEST_PATH`	Name of the `hydra.cypher.features.PathFeatures.shortestPath` field.
`java.lang.Boolean`	`shortestPath`	The shortestPath() function
`static Name`	`TYPE_`	Name of the `hydra.cypher.features.PathFeatures` type.

Constructor Summary

Constructors
Constructor Description

PathFeatures(java.lang.Boolean shortestPath)
Constructs an immutable PathFeatures.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PathFeatures.Builder`	`builder()`	Creates a new fluent builder for `PathFeatures`.
`int`	`compareTo(PathFeatures other)`
`boolean`	`equals(java.lang.Object other)`
`int`	`hashCode()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - TYPE_
```
public static final Name TYPE_
```
    Name of the hydra.cypher.features.PathFeatures type.
  - SHORTEST_PATH
```
public static final Name SHORTEST_PATH
```
    Name of the hydra.cypher.features.PathFeatures.shortestPath field.
  - shortestPath
```
public final java.lang.Boolean shortestPath
```
    The shortestPath() function
- Constructor Detail
  - PathFeatures
```
public PathFeatures(java.lang.Boolean shortestPath)
```
    Constructs an immutable PathFeatures.
    
    Parameters:
    
    shortestPath - The shortestPath() function
- Method Detail
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - compareTo
```
public int compareTo(PathFeatures other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<PathFeatures>
  - builder
```
public static PathFeatures.Builder builder()
```
    Creates a new fluent builder for PathFeatures.