SplitArgs (hydra-pg 0.17.6 API)

java.lang.Object
- hydra.tinkerpop.gremlin.SplitArgs

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SplitArgs>
```
public class SplitArgs
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<SplitArgs>
```
The arguments of a Gremlin split() step

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SplitArgs.Builder
A fluent builder for SplitArgs.

Field Summary

Fields
Modifier and Type	Field	Description
`StringNullableArgument`	`delimiter`
`static Name`	`DELIMITER`	Name of the `hydra.tinkerpop.gremlin.SplitArgs.delimiter` field.
`Optional<TraversalScopeArgument>`	`scope`
`static Name`	`SCOPE`	Name of the `hydra.tinkerpop.gremlin.SplitArgs.scope` field.
`static Name`	`TYPE_`	Name of the `hydra.tinkerpop.gremlin.SplitArgs` type.

Constructor Summary

Constructors
Constructor Description

SplitArgs(Optional<TraversalScopeArgument> scope, StringNullableArgument delimiter)
Constructs an immutable SplitArgs.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SplitArgs.Builder`	`builder()`	Creates a new fluent builder for `SplitArgs`.
`int`	`compareTo(SplitArgs other)`
`boolean`	`equals(java.lang.Object other)`
`int`	`hashCode()`
`java.lang.String`	`toString()`
`SplitArgs`	`withDelimiter(StringNullableArgument delimiter)`	Returns a copy of this `SplitArgs` with `delimiter` replaced.
`SplitArgs`	`withScope(Optional<TraversalScopeArgument> scope)`	Returns a copy of this `SplitArgs` with `scope` 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 hydra.tinkerpop.gremlin.SplitArgs type.
- SCOPE
```
public static final Name SCOPE
```
  Name of the hydra.tinkerpop.gremlin.SplitArgs.scope field.
- DELIMITER
```
public static final Name DELIMITER
```
  Name of the hydra.tinkerpop.gremlin.SplitArgs.delimiter field.
- scope
```
public final Optional<TraversalScopeArgument> scope
```
- delimiter
```
public final StringNullableArgument delimiter
```

Constructor Detail

SplitArgs

public SplitArgs(Optional<TraversalScopeArgument> scope,
                 StringNullableArgument delimiter)

Constructs an immutable SplitArgs.

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(SplitArgs other)
```
  Specified by:
  
  compareTo in interface java.lang.Comparable<SplitArgs>
- withScope
```
public SplitArgs withScope(Optional<TraversalScopeArgument> scope)
```
  Returns a copy of this SplitArgs with scope replaced.
- withDelimiter
```
public SplitArgs withDelimiter(StringNullableArgument delimiter)
```
  Returns a copy of this SplitArgs with delimiter replaced.
- builder
```
public static SplitArgs.Builder builder()
```
  Creates a new fluent builder for SplitArgs.