Skip to content

Commit

Permalink
Add javadoc generation for new kernel api modules
Browse files Browse the repository at this point in the history
  • Loading branch information
jjaderberg committed Aug 28, 2017
1 parent 3057db6 commit cda5a2e
Show file tree
Hide file tree
Showing 60 changed files with 162 additions and 162 deletions.
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* This interface is package-private because it is not generically useful. All use cases should use the explicit cursor * This interface is package-private because it is not generically useful. All use cases should use the explicit cursor
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


public interface CursorFactory public interface CursorFactory
{ {
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* A position is immutable and re-usable indefinitely. * A position is immutable and re-usable indefinitely.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Surface for accessing edge data. * Surface for accessing edge data.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Cursor for traversing the edge groups of a node. * Cursor for traversing the edge groups of a node.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Cursor for scanning edges of a schema index. * Cursor for scanning edges of a schema index.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Cursor for accessing manual index edges. * Cursor for accessing manual index edges.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Cursor for scanning edges, that is listing edges without grouping by source or target node. * Cursor for scanning edges, that is listing edges without grouping by source or target node.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Cursor for traversing the edges of a single node. * Cursor for traversing the edges of a single node.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* This class is really a renamed org.neo4j.kernel.api.schema.IndexQuery. Describes part of an index query related to * This class is really a renamed org.neo4j.kernel.api.schema.IndexQuery. Describes part of an index query related to
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* This class is really a renamed org.neo4j.kernel.api.schema.IndexDescriptor. Maybe it will compose an * This class is really a renamed org.neo4j.kernel.api.schema.IndexDescriptor. Maybe it will compose an
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Entry point for the Cypher Kernel API * Entry point for the Cypher Kernel API
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


import java.util.NoSuchElementException; import java.util.NoSuchElementException;


Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


interface ManualIndexCursor interface ManualIndexCursor
{ {
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


import java.util.Arrays; import java.util.Arrays;
import java.util.HashMap; import java.util.HashMap;
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Cursor for scanning nodes. * Cursor for scanning nodes.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Cursor for scanning the nodes of a schema index. * Cursor for scanning the nodes of a schema index.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Cursor for scanning the nodes of a label index. * Cursor for scanning the nodes of a label index.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Cursor for accessing manual index nodes. * Cursor for accessing manual index nodes.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


import org.neo4j.values.storable.Value; import org.neo4j.values.storable.Value;


Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* A PlannerFrame exists from the start of Cypher query planning, until the last Graph interaction. * A PlannerFrame exists from the start of Cypher query planning, until the last Graph interaction.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


import java.util.regex.Pattern; import java.util.regex.Pattern;


Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Experimental friend of the NeighbourCursor. * Experimental friend of the NeighbourCursor.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Defines the read operations of the Kernel API. * Defines the read operations of the Kernel API.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* The entry point for runtime access to the Kernel * The entry point for runtime access to the Kernel
Expand Down
Expand Up @@ -17,15 +17,15 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Initializer for spreading a scan operator over multiple cursors for use from different threads in parallel. * Initializer for spreading a scan operator over multiple cursors for use from different threads in parallel.
* *
* @param <Cursor> * @param <Cursor>
* the type of cursor this object initializes. * the type of cursor this object initializes.
*/ */
public interface Scan<Cursor extends org.neo4j.impl.kernel.api.Cursor> public interface Scan<Cursor extends org.neo4j.internal.kernel.api.Cursor>
{ {
void initialize( Cursor cursor ); void initialize( Cursor cursor );
} }
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* After invoking {@link #suspend()} this cursor is closed and needs to be re-initialized. * After invoking {@link #suspend()} this cursor is closed and needs to be re-initialized.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


/** /**
* Token creation and lookup. * Token creation and lookup.
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


public interface Transaction extends Read, Write public interface Transaction extends Read, Write
{ {
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


import org.neo4j.values.storable.Value; import org.neo4j.values.storable.Value;


Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


public class CursorFactoryTestBase public class CursorFactoryTestBase
{ {
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


import org.junit.Test; import org.junit.Test;


Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.kernel.api; package org.neo4j.internal.kernel.api;


import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU Affero General Public License * You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.store.cursors; package org.neo4j.internal.store.cursors;


import java.lang.reflect.Field; import java.lang.reflect.Field;
import java.lang.reflect.Modifier; import java.lang.reflect.Modifier;
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU Affero General Public License * You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.store.cursors; package org.neo4j.internal.store.cursors;


import static java.lang.String.format; import static java.lang.String.format;


Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU Affero General Public License * You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.store.cursors; package org.neo4j.internal.store.cursors;


public abstract class MemoryManager public abstract class MemoryManager
{ {
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU Affero General Public License * You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.store.cursors; package org.neo4j.internal.store.cursors;


public abstract class PageManager extends MemoryManager public abstract class PageManager extends MemoryManager
{ {
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU Affero General Public License * You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.store.cursors; package org.neo4j.internal.store.cursors;


public abstract class ReadCursor extends MemoryAccess implements AutoCloseable public abstract class ReadCursor extends MemoryAccess implements AutoCloseable
{ {
Expand Down
Expand Up @@ -17,7 +17,7 @@
* You should have received a copy of the GNU Affero General Public License * You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.store.cursors; package org.neo4j.internal.store.cursors;


public abstract class Writer extends MemoryAccess implements AutoCloseable public abstract class Writer extends MemoryAccess implements AutoCloseable
{ {
Expand Down
Expand Up @@ -17,16 +17,16 @@
* You should have received a copy of the GNU Affero General Public License * You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
package org.neo4j.impl.store.prototype.neole; package org.neo4j.internal.store.prototype.neole;


import java.nio.BufferUnderflowException; import java.nio.BufferUnderflowException;
import java.nio.charset.Charset; import java.nio.charset.Charset;


import org.neo4j.impl.store.cursors.ReadCursor; import org.neo4j.internal.store.cursors.ReadCursor;


import static java.lang.Math.min; import static java.lang.Math.min;
import static org.neo4j.impl.store.prototype.neole.ReadStore.combineReference; import static org.neo4j.internal.store.prototype.neole.ReadStore.combineReference;
import static org.neo4j.impl.store.prototype.neole.ReadStore.nextPowerOfTwo; import static org.neo4j.internal.store.prototype.neole.ReadStore.nextPowerOfTwo;


/** /**
* The ByteBlockCursor would be used to read data from dynamic stores. This will help if we decide to implement * The ByteBlockCursor would be used to read data from dynamic stores. This will help if we decide to implement
Expand Down

0 comments on commit cda5a2e

Please sign in to comment.