ModulusExpression (hydra-pg 0.17.6 API)

java.lang.Object
- openGql.grammar.ModulusExpression

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ModulusExpression>
```
public class ModulusExpression
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<ModulusExpression>
```
A GQL modulus expression

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ModulusExpression.Builder
A fluent builder for ModulusExpression.

Field Summary

Fields
Modifier and Type	Field	Description
`NumericValueExpression`	`dividend`
`static Name`	`DIVIDEND`	Name of the `openGql.grammar.ModulusExpression.dividend` field.
`NumericValueExpression`	`divisor`
`static Name`	`DIVISOR`	Name of the `openGql.grammar.ModulusExpression.divisor` field.
`static Name`	`TYPE_`	Name of the `openGql.grammar.ModulusExpression` type.

Constructor Summary

Constructors
Constructor Description

ModulusExpression(NumericValueExpression dividend, NumericValueExpression divisor)
Constructs an immutable ModulusExpression.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ModulusExpression.Builder`	`builder()`	Creates a new fluent builder for `ModulusExpression`.
`int`	`compareTo(ModulusExpression other)`
`boolean`	`equals(java.lang.Object other)`
`int`	`hashCode()`
`java.lang.String`	`toString()`
`ModulusExpression`	`withDividend(NumericValueExpression dividend)`	Returns a copy of this `ModulusExpression` with `dividend` replaced.
`ModulusExpression`	`withDivisor(NumericValueExpression divisor)`	Returns a copy of this `ModulusExpression` with `divisor` 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.ModulusExpression type.
- DIVIDEND
```
public static final Name DIVIDEND
```
  Name of the openGql.grammar.ModulusExpression.dividend field.
- DIVISOR
```
public static final Name DIVISOR
```
  Name of the openGql.grammar.ModulusExpression.divisor field.
- dividend
```
public final NumericValueExpression dividend
```
- divisor
```
public final NumericValueExpression divisor
```

Constructor Detail

ModulusExpression

public ModulusExpression(NumericValueExpression dividend,
                         NumericValueExpression divisor)

Constructs an immutable ModulusExpression.

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(ModulusExpression other)
```
  Specified by:
  
  compareTo in interface java.lang.Comparable<ModulusExpression>
- withDividend
```
public ModulusExpression withDividend(NumericValueExpression dividend)
```
  Returns a copy of this ModulusExpression with dividend replaced.
- withDivisor
```
public ModulusExpression withDivisor(NumericValueExpression divisor)
```
  Returns a copy of this ModulusExpression with divisor replaced.
- builder
```
public static ModulusExpression.Builder builder()
```
  Creates a new fluent builder for ModulusExpression.