RelativeDirectoryPath (hydra-pg 0.17.6 API)

java.lang.Object
- openGql.grammar.RelativeDirectoryPath

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RelativeDirectoryPath>
```
public class RelativeDirectoryPath
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<RelativeDirectoryPath>
```
A GQL relative directory path

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class RelativeDirectoryPath.Builder
A fluent builder for RelativeDirectoryPath.

Field Summary

Fields
Modifier and Type	Field	Description
`static Name`	`PARENT_DIRECTORIES`	Name of the `openGql.grammar.RelativeDirectoryPath.parentDirectories` field.
`java.lang.Integer`	`parentDirectories`
`static Name`	`SIMPLE_PATH`	Name of the `openGql.grammar.RelativeDirectoryPath.simplePath` field.
`Optional<java.util.List<java.lang.String>>`	`simplePath`
`static Name`	`TYPE_`	Name of the `openGql.grammar.RelativeDirectoryPath` type.

Constructor Summary

Constructors
Constructor	Description
`RelativeDirectoryPath(java.lang.Integer parentDirectories, Optional<java.util.List<java.lang.String>> simplePath)`	Constructs an immutable `RelativeDirectoryPath`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static RelativeDirectoryPath.Builder`	`builder()`	Creates a new fluent builder for `RelativeDirectoryPath`.
`int`	`compareTo(RelativeDirectoryPath other)`
`boolean`	`equals(java.lang.Object other)`
`int`	`hashCode()`
`java.lang.String`	`toString()`
`RelativeDirectoryPath`	`withParentDirectories(java.lang.Integer parentDirectories)`	Returns a copy of this `RelativeDirectoryPath` with `parentDirectories` replaced.
`RelativeDirectoryPath`	`withSimplePath(Optional<java.util.List<java.lang.String>> simplePath)`	Returns a copy of this `RelativeDirectoryPath` with `simplePath` replaced.

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 openGql.grammar.RelativeDirectoryPath type.
- PARENT_DIRECTORIES
```
public static final Name PARENT_DIRECTORIES
```
  Name of the openGql.grammar.RelativeDirectoryPath.parentDirectories field.
- SIMPLE_PATH
```
public static final Name SIMPLE_PATH
```
  Name of the openGql.grammar.RelativeDirectoryPath.simplePath field.
- parentDirectories
```
public final java.lang.Integer parentDirectories
```
- simplePath
```
public final Optional<java.util.List<java.lang.String>> simplePath
```

Constructor Detail

RelativeDirectoryPath

public RelativeDirectoryPath(java.lang.Integer parentDirectories,
                             Optional<java.util.List<java.lang.String>> simplePath)

Constructs an immutable RelativeDirectoryPath.

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(RelativeDirectoryPath other)
```
  Specified by:
  
  compareTo in interface java.lang.Comparable<RelativeDirectoryPath>
- withParentDirectories
```
public RelativeDirectoryPath withParentDirectories(java.lang.Integer parentDirectories)
```
  Returns a copy of this RelativeDirectoryPath with parentDirectories replaced.
- withSimplePath
```
public RelativeDirectoryPath withSimplePath(Optional<java.util.List<java.lang.String>> simplePath)
```
  Returns a copy of this RelativeDirectoryPath with simplePath replaced.
- builder
```
public static RelativeDirectoryPath.Builder builder()
```
  Creates a new fluent builder for RelativeDirectoryPath.