JAVA-901: cleanup org.bson.Lazy*

trnl · trnl · commit 0ffc7b00fb94 · 2013-08-15T14:28:49.000+03:00
diff --git a/src/main/org/bson/KeyCachingLazyBSONObject.java b/src/main/org/bson/KeyCachingLazyBSONObject.java
@@ -22,7 +22,10 @@
 /**
  * @author brendan
  * @author scotthernandez
+ *
+ * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
  */
+@Deprecated
 public class KeyCachingLazyBSONObject extends LazyBSONObject {
 
     public KeyCachingLazyBSONObject(byte[] data , LazyBSONCallback cbk) { super( data , cbk ); }
diff --git a/src/main/org/bson/LazyBSONCallback.java b/src/main/org/bson/LazyBSONCallback.java
@@ -54,6 +54,10 @@ public void gotBinary( String name, byte type, byte[] data ){
         setRootObject( createObject( data, 0 ) );
     }
 
+    /**
+     * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.
+     */
+    @Deprecated
     public void setRootObject( Object root ){
         _root = root;
     }
diff --git a/src/main/org/bson/LazyBSONObject.java b/src/main/org/bson/LazyBSONObject.java
@@ -91,6 +91,10 @@ public void remove(){
         int offset = _doc_start_offset + FIRST_ELMT_OFFSET;
     }
 
+    /**
+     * @deprecated This class is NOT a part of public API and will be dropped in 3.x versions.
+     */
+    @Deprecated
     public class LazyBSONKeySet extends ReadOnlySet<String> {
 
         /**
@@ -431,6 +435,10 @@ public Set<Map.Entry<String, Object>> entrySet(){
         return new LazyBSONEntrySet();
     }
 
+    /**
+     * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.
+     */
+    @Deprecated
     protected boolean isElementEmpty( int offset ){
         return getElementType( offset ) == BSON.EOO;
     }
@@ -456,10 +464,18 @@ private String getElementFieldName( final int offset ){
         return _input.getCString( offset );
     }
 
+    /**
+     * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.
+     */
+    @Deprecated
     protected byte getElementType( final int offset ){
         return _input.get( offset );
     }
 
+    /**
+     * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.
+     */
+    @Deprecated
     protected int getElementBSONSize( int offset ){
         int x = 0;
         byte type = getElementType( offset++ );
@@ -522,7 +538,10 @@ protected int getElementBSONSize( int offset ){
      * Returns the size of the BSON cstring at the given offset in the buffer
      * @param offset the offset into the buffer
      * @return the size of the BSON cstring, including the null terminator
+     *
+     * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.
      */
+    @Deprecated
     protected int sizeCString( int offset ){
         int end = offset;
         while ( true ){
@@ -535,6 +554,10 @@ protected int sizeCString( int offset ){
         return end - offset + 1;
     }
 
+    /**
+     * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.
+     */
+    @Deprecated
     protected Object getElementValue( ElementRecord record ){
         switch ( record.type ){
             case BSON.EOO:
@@ -645,6 +668,10 @@ private Object readBinary( int valueOffset ){
         return bin;
     }
 
+    protected int getOffset(){
+        return _doc_start_offset;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
@@ -677,10 +704,23 @@ public String toString(){
      */
     final static int FIRST_ELMT_OFFSET = 4;
 
+    /**
+     * @deprecated Please use {@link #getOffset()} instead.
+     */
+    @Deprecated
     protected final int _doc_start_offset;
 
+    /**
+     *  @deprecated This field is NOT a part of public API and will be dropped in 3.x versions.
+     */
+    @Deprecated
     protected final BSONByteBuffer _input; // TODO - Guard this with synchronicity?
     // callback is kept to create sub-objects on the fly
+
+    /**
+     * @deprecated This field is NOT a part of public API and will be dropped in 3.x versions.
+     */
+    @Deprecated
     protected final LazyBSONCallback _callback;
     private static final Logger log = Logger.getLogger( "org.bson.LazyBSONObject" );
 }

Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,10 @@ public void gotBinary( String name, byte type, byte[] data ){`
`54`	`54`	`setRootObject( createObject( data, 0 ) );`
`55`	`55`	`}`
`56`	`56`
	`57`	`+ /**`
	`58`	`+ * @deprecated This method is NOT a part of public API and will be dropped in 3.x versions.`
	`59`	`+ */`
	`60`	`+ @Deprecated`
`57`	`61`	`public void setRootObject( Object root ){`
`58`	`62`	`_root = root;`
`59`	`63`	`}`