postgresql-jdbc.git / summary / log / commit / refs

commit    e602ea1693530bdaeeb9751f85519df77bfbd072
Author:   Dave Cramer <davec@fastcrypt.com>
Date:     Tue Sep 27 09:34:49 2011 +0000

    missing file


 org/postgresql/util/PGBinaryObject.java | 44 +++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/org/postgresql/util/PGBinaryObject.java b/org/postgresql/util/PGBinaryObject.java
new file mode 100644
index 00000000..bfed16f9
--- /dev/null
+++ b/org/postgresql/util/PGBinaryObject.java
@@ -0,0 +1,44 @@
+/*-------------------------------------------------------------------------
+*
+* Copyright (c) 2011, PostgreSQL Global Development Group
+*
+* IDENTIFICATION
+*   $PostgreSQL: pgjdbc/org/postgresql/util/PGBinaryObject.java,v 1.0 2011/09/30 13:50:29 davecramer Exp $
+*
+*-------------------------------------------------------------------------
+*/package org.postgresql.util;
+
+import java.sql.SQLException;
+
+/**
+ *     PGBinaryObject is a inteface that classes extending {@link PGobject} can use to
+ *     take advantage of more optimal binary encoding of the data type.
+ */
+public interface PGBinaryObject {
+    /**
+     * This method is called to set the value of this object.
+     *
+     * @param value data containing the binary representation of the value of the object
+     * @param offset the offset in the byte array where object data starts
+     * @exception SQLException thrown if value is invalid for this type
+     */
+    public void setByteValue(byte[] value, int offset) throws SQLException;
+    
+    /**
+     * This method is called to return the number of bytes needed to store 
+     * this object in the binary form required by org.postgresql.
+     *
+     * @return the number of bytes needed to store this object
+     */
+    public int lengthInBytes();
+
+    /**
+     * This method is called the to store the value of the object, in the
+     * binary form required by org.postgresql.
+     *
+     * @param bytes the array to store the value, it is guaranteed to be at
+     *        lest {@link #lengthInBytes} in size.
+     * @param offset the offset in the byte array where object must be stored
+     */
+    public void toBytes(byte[] bytes, int offset);
+}


[parent: f6602e67fdfe]