Skip to content

Commit

Permalink
javadocs, cleanup, checkstyle and license fix
Browse files Browse the repository at this point in the history
  • Loading branch information
fickludd committed Nov 9, 2017
1 parent e760dca commit 5cf08ec
Show file tree
Hide file tree
Showing 18 changed files with 30 additions and 392 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@
*/
package org.neo4j.internal.kernel.api;

/**
* Allocates Cursors. To read data from the Kernel, Cursors are needed. A Cursor factory let's the Kernel consumer
* allocate all types of cursors, which can then be reused for multiple read operations.
*/
public interface CursorFactory
{
// entities
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
*/
package org.neo4j.internal.kernel.api;

/**
* A cursor for accessing data in an explicit index.
*/
interface ExplicitIndexCursor
{
int totalExpectedCursorSize();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@
import org.neo4j.internal.kernel.api.exceptions.KernelException;
import org.neo4j.values.storable.Value;

/**
* Operations for querying and seeking in explicit indexes.
*/
public interface ExplicitIndexRead
{
void nodeExplicitIndexLookup( NodeExplicitIndexCursor cursor, String index, String key, Value value )
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
*/
package org.neo4j.internal.kernel.api;

/**
* The Kernel.
*/
public interface Kernel
{
CursorFactory cursors();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
*/
package org.neo4j.internal.kernel.api;

/**
* Methods for acquiring and releasing locks.
*/
public interface Locks
{
}

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
package org.neo4j.internal.kernel.api;

/**
* Defines the read operations of the Kernel API.
* Defines the graph read operations of the Kernel.
*/
public interface Read
{
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
*/
package org.neo4j.internal.kernel.api;

/**
* Surface for getting schema information, such as fetching specific indexes or constraints.
*/
public interface SchemaRead
{
IndexReference index( int label, int... properties );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
*/
package org.neo4j.internal.kernel.api;

/**
* Surface for creating and dropping indexes and constraints.
*/
public interface SchemaWrite
{
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
*/
package org.neo4j.internal.kernel.api;

/**
* A Session is used to gain
*/
public interface Session extends AutoCloseable
{
Transaction beginTransaction();
Expand Down

0 comments on commit 5cf08ec

Please sign in to comment.