<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_0) on Wed Dec 30 04:50:30 EST 2009 -->
<TITLE>
KeyRange
</TITLE>
<META NAME="date" CONTENT="2009-12-30">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="KeyRange";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../com/sleepycat/util/keyrange/KeyRangeException.html" title="class in com.sleepycat.util.keyrange"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/sleepycat/util/keyrange/KeyRange.html" target="_top"><B>FRAMES</B></A>
<A HREF="KeyRange.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sleepycat.util.keyrange</FONT>
<BR>
Class KeyRange</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.util.keyrange.KeyRange</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>KeyRange</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Encapsulates a key range for use with a RangeCursor.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#ZERO_LENGTH_BYTE_ARRAY">ZERO_LENGTH_BYTE_ARRAY</A></B></CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#KeyRange(java.util.Comparator)">KeyRange</A></B>(java.util.Comparator comparator)</CODE>
<BR>
Creates an unconstrained key range.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#check(com.sleepycat.db.DatabaseEntry)">check</A></B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key)</CODE>
<BR>
Returns whether a given key is within range.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#check(com.sleepycat.db.DatabaseEntry, boolean)">check</A></B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key,
boolean inclusive)</CODE>
<BR>
Returns whether a given key is within range.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#checkBegin(com.sleepycat.db.DatabaseEntry, boolean)">checkBegin</A></B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key,
boolean inclusive)</CODE>
<BR>
Returns whether the given key is within range with respect to the
beginning of the range.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#checkEnd(com.sleepycat.db.DatabaseEntry, boolean)">checkEnd</A></B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key,
boolean inclusive)</CODE>
<BR>
Returns whether the given key is within range with respect to the
end of the range.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#compare(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">compare</A></B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key1,
<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key2)</CODE>
<BR>
Compares two keys, using the user comparator if there is one.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#compareBytes(byte[], int, int, byte[], int, int)">compareBytes</A></B>(byte[] data1,
int offset1,
int size1,
byte[] data2,
int offset2,
int size2)</CODE>
<BR>
Compares two keys as unsigned byte arrays, which is the default
comparison used by JE/DB.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#copy(com.sleepycat.db.DatabaseEntry)">copy</A></B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> from)</CODE>
<BR>
Returns a copy of an entry.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#copy(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">copy</A></B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> from,
<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> to)</CODE>
<BR>
Copies one entry to another.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#copyBytes(byte[])">copyBytes</A></B>(byte[] bytes)</CODE>
<BR>
Copies a byte array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#equalBytes(byte[], int, int, byte[], int, int)">equalBytes</A></B>(byte[] data1,
int offset1,
int size1,
byte[] data2,
int offset2,
int size2)</CODE>
<BR>
Compares two byte arrays for equality.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#equalBytes(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">equalBytes</A></B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> e1,
<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> e2)</CODE>
<BR>
Returns the two DatabaseEntry objects have the same data value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#getByteArray(com.sleepycat.db.DatabaseEntry)">getByteArray</A></B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> entry)</CODE>
<BR>
Returns an entry's byte array, copying it if the entry offset is
non-zero.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#getByteArray(com.sleepycat.db.DatabaseEntry, int)">getByteArray</A></B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> entry,
int maxBytes)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#getSingleKey()">getSingleKey</A></B>()</CODE>
<BR>
Returns the key of a single-key range, or null if not a single-key
range.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#hasBound()">hasBound</A></B>()</CODE>
<BR>
Returns whether this range has a begin or end bound.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#isSingleKey()">isSingleKey</A></B>()</CODE>
<BR>
Returns whether this is a single-key range.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html" title="class in com.sleepycat.util.keyrange">KeyRange</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#subRange(com.sleepycat.db.DatabaseEntry)">subRange</A></B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key)</CODE>
<BR>
Creates a range for a single key.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html" title="class in com.sleepycat.util.keyrange">KeyRange</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#subRange(com.sleepycat.db.DatabaseEntry, boolean, com.sleepycat.db.DatabaseEntry, boolean)">subRange</A></B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> beginKey,
boolean beginInclusive,
<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> endKey,
boolean endInclusive)</CODE>
<BR>
Creates a range that is the intersection of this range and the given
range parameters.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#toString()">toString</A></B>()</CODE>
<BR>
Formats this range as a string for debugging.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html#toString(com.sleepycat.db.DatabaseEntry)">toString</A></B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> dbt)</CODE>
<BR>
Converts the byte array of this thang to space-separated integers,
and suffixed by the record number if applicable.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ZERO_LENGTH_BYTE_ARRAY"><!-- --></A><H3>
ZERO_LENGTH_BYTE_ARRAY</H3>
<PRE>
public static final byte[] <B>ZERO_LENGTH_BYTE_ARRAY</B></PRE>
<DL>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="KeyRange(java.util.Comparator)"><!-- --></A><H3>
KeyRange</H3>
<PRE>
public <B>KeyRange</B>(java.util.Comparator comparator)</PRE>
<DL>
<DD>Creates an unconstrained key range.
<P>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="subRange(com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
subRange</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html" title="class in com.sleepycat.util.keyrange">KeyRange</A> <B>subRange</B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key)
throws <A HREF="../../../../com/sleepycat/util/keyrange/KeyRangeException.html" title="class in com.sleepycat.util.keyrange">KeyRangeException</A></PRE>
<DL>
<DD>Creates a range for a single key.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sleepycat/util/keyrange/KeyRangeException.html" title="class in com.sleepycat.util.keyrange">KeyRangeException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="subRange(com.sleepycat.db.DatabaseEntry, boolean, com.sleepycat.db.DatabaseEntry, boolean)"><!-- --></A><H3>
subRange</H3>
<PRE>
public <A HREF="../../../../com/sleepycat/util/keyrange/KeyRange.html" title="class in com.sleepycat.util.keyrange">KeyRange</A> <B>subRange</B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> beginKey,
boolean beginInclusive,
<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> endKey,
boolean endInclusive)
throws <A HREF="../../../../com/sleepycat/util/keyrange/KeyRangeException.html" title="class in com.sleepycat.util.keyrange">KeyRangeException</A></PRE>
<DL>
<DD>Creates a range that is the intersection of this range and the given
range parameters.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../com/sleepycat/util/keyrange/KeyRangeException.html" title="class in com.sleepycat.util.keyrange">KeyRangeException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="isSingleKey()"><!-- --></A><H3>
isSingleKey</H3>
<PRE>
public final boolean <B>isSingleKey</B>()</PRE>
<DL>
<DD>Returns whether this is a single-key range.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSingleKey()"><!-- --></A><H3>
getSingleKey</H3>
<PRE>
public final <A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> <B>getSingleKey</B>()</PRE>
<DL>
<DD>Returns the key of a single-key range, or null if not a single-key
range.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="hasBound()"><!-- --></A><H3>
hasBound</H3>
<PRE>
public final boolean <B>hasBound</B>()</PRE>
<DL>
<DD>Returns whether this range has a begin or end bound.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>Formats this range as a string for debugging.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="check(com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
check</H3>
<PRE>
public boolean <B>check</B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key)</PRE>
<DL>
<DD>Returns whether a given key is within range.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="check(com.sleepycat.db.DatabaseEntry, boolean)"><!-- --></A><H3>
check</H3>
<PRE>
public boolean <B>check</B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key,
boolean inclusive)</PRE>
<DL>
<DD>Returns whether a given key is within range.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="checkBegin(com.sleepycat.db.DatabaseEntry, boolean)"><!-- --></A><H3>
checkBegin</H3>
<PRE>
public boolean <B>checkBegin</B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key,
boolean inclusive)</PRE>
<DL>
<DD>Returns whether the given key is within range with respect to the
beginning of the range.
<p>The inclusive parameter should be true for checking a key read from
the database; this will require that the key is within range. When
inclusive=false the key is allowed to be equal to the beginKey for the
range; this is used for checking a new exclusive bound of a
sub-range.</p>
<p>Note that when inclusive=false and beginInclusive=true our check is
not exactly correct because in theory we should allow the key to be "one
less" than the existing bound; however, checking for "one less" is
impossible so we do the best we can and test the bounds
conservatively.</p>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="checkEnd(com.sleepycat.db.DatabaseEntry, boolean)"><!-- --></A><H3>
checkEnd</H3>
<PRE>
public boolean <B>checkEnd</B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key,
boolean inclusive)</PRE>
<DL>
<DD>Returns whether the given key is within range with respect to the
end of the range. See checkBegin for details.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="compare(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
compare</H3>
<PRE>
public int <B>compare</B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key1,
<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key2)</PRE>
<DL>
<DD>Compares two keys, using the user comparator if there is one.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="copyBytes(byte[])"><!-- --></A><H3>
copyBytes</H3>
<PRE>
public static byte[] <B>copyBytes</B>(byte[] bytes)</PRE>
<DL>
<DD>Copies a byte array.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="compareBytes(byte[], int, int, byte[], int, int)"><!-- --></A><H3>
compareBytes</H3>
<PRE>
public static int <B>compareBytes</B>(byte[] data1,
int offset1,
int size1,
byte[] data2,
int offset2,
int size2)</PRE>
<DL>
<DD>Compares two keys as unsigned byte arrays, which is the default
comparison used by JE/DB.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="equalBytes(byte[], int, int, byte[], int, int)"><!-- --></A><H3>
equalBytes</H3>
<PRE>
public static boolean <B>equalBytes</B>(byte[] data1,
int offset1,
int size1,
byte[] data2,
int offset2,
int size2)</PRE>
<DL>
<DD>Compares two byte arrays for equality.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="copy(com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
copy</H3>
<PRE>
public static <A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> <B>copy</B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> from)</PRE>
<DL>
<DD>Returns a copy of an entry.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="copy(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
copy</H3>
<PRE>
public static void <B>copy</B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> from,
<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> to)</PRE>
<DL>
<DD>Copies one entry to another.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getByteArray(com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
getByteArray</H3>
<PRE>
public static byte[] <B>getByteArray</B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> entry)</PRE>
<DL>
<DD>Returns an entry's byte array, copying it if the entry offset is
non-zero.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getByteArray(com.sleepycat.db.DatabaseEntry, int)"><!-- --></A><H3>
getByteArray</H3>
<PRE>
public static byte[] <B>getByteArray</B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> entry,
int maxBytes)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="equalBytes(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
equalBytes</H3>
<PRE>
public static boolean <B>equalBytes</B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> e1,
<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> e2)</PRE>
<DL>
<DD>Returns the two DatabaseEntry objects have the same data value.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="toString(com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
toString</H3>
<PRE>
public static java.lang.String <B>toString</B>(<A HREF="../../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> dbt)</PRE>
<DL>
<DD>Converts the byte array of this thang to space-separated integers,
and suffixed by the record number if applicable.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dbt</CODE> - the thang to convert.
<DT><B>Returns:</B><DD>the resulting string.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../com/sleepycat/util/keyrange/KeyRangeException.html" title="class in com.sleepycat.util.keyrange"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/sleepycat/util/keyrange/KeyRange.html" target="_top"><B>FRAMES</B></A>
<A HREF="KeyRange.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
bc1980b66a68f286299491ee8724e71c
>
files
>
470
