summaryrefslogtreecommitdiff
path: root/lang/java/src/com/sleepycat/db/PartitionHandler.java
diff options
context:
space:
mode:
Diffstat (limited to 'lang/java/src/com/sleepycat/db/PartitionHandler.java')
-rw-r--r--lang/java/src/com/sleepycat/db/PartitionHandler.java12
1 files changed, 10 insertions, 2 deletions
diff --git a/lang/java/src/com/sleepycat/db/PartitionHandler.java b/lang/java/src/com/sleepycat/db/PartitionHandler.java
index dce9e6a6..aa764c69 100644
--- a/lang/java/src/com/sleepycat/db/PartitionHandler.java
+++ b/lang/java/src/com/sleepycat/db/PartitionHandler.java
@@ -1,7 +1,7 @@
/*-
* See the file LICENSE for redistribution information.
*
- * Copyright (c) 2001, 2012 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2001, 2015 Oracle and/or its affiliates. All rights reserved.
*
* $Id$
*/
@@ -9,7 +9,13 @@
package com.sleepycat.db;
/**
-An interface specifying how Btree prefixes should be calculated.
+An interface specifying how to set up database partitioning.
+Implementation of this interface is required when
+{@link com.sleepycat.db.Database} is opened and
+{@link DatabaseConfig#setPartitionByCallback DatabaseConfig.setPartitionByCallback} is called.
+<p>
+You configure the database with this handler using the
+{@link DatabaseConfig#setPartitionByCallback DatabaseConfig.setPartitionByCallback} method.
*/
public interface PartitionHandler {
/**
@@ -19,6 +25,8 @@ public interface PartitionHandler {
The enclosing database handle.
@param key
A database entry representing a database key.
+ @return
+ A partition number for the key.
*/
int partition(Database db, DatabaseEntry key);
}