Hint (Neo4j Cypher DSL (Core) 2021.2.3 API)

java.lang.Object
- org.neo4j.cypherdsl.core.Hint

All Implemented Interfaces:

Visitable
```
public final class Hint
extends java.lang.Object
implements Visitable
```
Visitable implementing hints. See ExposesHints.

Since:

2021.0.0

Author:

Michael J. Simons

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`accept(Visitor visitor)`	Accept a `Visitor` visiting this `Visitable` and its nested `Visitable`s if applicable.
`static Hint`	`useIndexFor(boolean seek, Property... properties)`	Creates an index hint.
`static Hint`	`useJoinOn(SymbolicName... name)`	Creates a join hint on one or more symbolic names.
`static Hint`	`useScanFor(Node node)`	Creates an index scan hint.

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

- Method Detail
  - useIndexFor
```
public static Hint useIndexFor(boolean seek,
                               Property... properties)
```
    Creates an index hint. Mostly useful when building elements outside the fluent DSL.
    
    Parameters:
    
    seek - Set to true to use the index for seeks only
    
    properties - The properties to use in the index, must know their container
    
    Returns:
    
    A hint
    
    Since:
    
    2021.2.3
  - useScanFor
```
public static Hint useScanFor(Node node)
```
    Creates an index scan hint. Mostly useful when building elements outside the fluent DSL.
    
    Parameters:
    
    node - The node who's label and name should be used to define the scan hint
    
    Returns:
    
    A hint
    
    Since:
    
    2021.2.3
  - useJoinOn
```
public static Hint useJoinOn(SymbolicName... name)
```
    Creates a join hint on one or more symbolic names.
    
    Parameters:
    
    name - The names that are supposed to provide the join point
    
    Returns:
    
    A hint
    
    Since:
    
    2021.2.3
  - accept
```
public void accept(Visitor visitor)
```
    Description copied from interface: Visitable
    
    Accept a Visitor visiting this Visitable and its nested Visitables if applicable.
    
    Specified by:
    
    accept in interface Visitable
    
    Parameters:
    
    visitor - the visitor to notify, must not be null.