Hi,
if this is accepted, could someone with CVS write access please commit it,
Thanks,
Carsten
ChangeLog (also attached):
2006-05-25 Carsten Neumann <[EMAIL PROTECTED]>
* java/io/ObjectStreamConstants.java: Added API docs.
Index: java/io/ObjectStreamConstants.java
===================================================================
RCS file: /sources/classpath/classpath/java/io/ObjectStreamConstants.java,v
retrieving revision 1.15
diff -u -r1.15 ObjectStreamConstants.java
--- java/io/ObjectStreamConstants.java 21 May 2006 20:53:14 -0000 1.15
+++ java/io/ObjectStreamConstants.java 25 May 2006 12:41:17 -0000
@@ -50,8 +50,6 @@
*/
public interface ObjectStreamConstants
{
- // FIXME: Javadoc comment these values.
-
/**
* The serialization stream protocol version 1. This version was
* the default serialization protocol before JDK 1.2.
@@ -70,39 +68,160 @@
*/
int PROTOCOL_VERSION_2 = 2;
+ /**
+ * The magic number that is written as part of the stream header.
+ */
short STREAM_MAGIC = (short)0xaced;
+
+ /**
+ * The stream version number that is written as part of the stream header.
+ * Note that this is different from the protocol version that specifies
+ * the data format for the stream.
+ */
short STREAM_VERSION = 5;
+ /**
+ * Token value to designate a <code>null</code> reference in the stream.
+ */
byte TC_NULL = (byte)112; //0x70
+
+ /**
+ * Token value to designate a reference to an already serialized object.
+ */
byte TC_REFERENCE = (byte)113; //0x71
+
+ /**
+ * Token value to designate a class descriptor is next in the stream.
+ */
byte TC_CLASSDESC = (byte)114; //0x72
+
+ /**
+ * Token value to designate a new object is next in the stream.
+ */
byte TC_OBJECT = (byte)115; //0x73
+
+ /**
+ * Token value to designate a new string is next in the stream.
+ */
byte TC_STRING = (byte)116; //0x74
+
+ /**
+ * Token value to designate a new array is next in the stream.
+ */
byte TC_ARRAY = (byte)117; //0x75
+
+ /**
+ * Token reference to designate a reference to a class.
+ */
byte TC_CLASS = (byte)118; //0x76
+
+ /**
+ * Token value to designate a block of primitive data is next in the stream.
+ * The next byte in the stream holds the size of the block (in bytes).
+ */
byte TC_BLOCKDATA = (byte)119; //0x77
+
+ /**
+ * Token value to designate the end of a block of primitve data.
+ */
byte TC_ENDBLOCKDATA = (byte)120; //0x78
+
+ /**
+ * Token value to designate a reset of the stream state.
+ */
byte TC_RESET = (byte)121; //0x79
+
+ /**
+ * Token value to designate a long block of primitive data is next in the
+ * stream. The next long in the stream holds the size of the block
+ * (in bytes).
+ */
byte TC_BLOCKDATALONG = (byte)122; //0x7A
+
+ /**
+ * Token value to designate an exception occured during serialization.
+ */
byte TC_EXCEPTION = (byte)123; //0x7B
+
+ /**
+ * Token value to designate a long string is next in the stream.
+ */
byte TC_LONGSTRING = (byte)124; //0x7C
+
+ /**
+ * Token value to designate a proxy class descriptor is next in the stream.
+ */
byte TC_PROXYCLASSDESC = (byte)125; //0x7D
- byte TC_ENUM = (byte)126; //0x7E
+ /**
+ * Token value to designate an enum constant is next in the stream.
+ *
+ * @since 1.5
+ */
+ byte TC_ENUM = (byte)126; //0x7E
+
+ /**
+ * The first token value.
+ */
byte TC_BASE = TC_NULL;
+
+ /**
+ * The last token value.
+ */
byte TC_MAX = TC_ENUM;
+ /**
+ * The first handle that will be assigned to an object, for later references.
+ */
int baseWireHandle = 0x7e0000;
+ /**
+ * Flag used in <code>ObjectStreamClass</code> to designate that the class
+ * defines the <code>writeObject</code> method.
+ */
byte SC_WRITE_METHOD = 0x01;
+
+ /**
+ * Flag used in <code>ObjectStreamClass</code> to designate that the class
+ * is serializeable.
+ */
byte SC_SERIALIZABLE = 0x02;
+
+ /**
+ * Flag used in <code>ObjectStreamClass</code> to designate that the class
+ * is externalizable.
+ */
byte SC_EXTERNALIZABLE = 0x04;
+
+ /**
+ * Flag used in <code>ObjectStreamClass</code> to designate that
+ * externalizable data is written in block data mode.
+ *
+ * @since 1.2
+ */
byte SC_BLOCK_DATA = 0x08;
byte SC_ENUM = 0x10;
+ /**
+ * Flag used in <code>ObjectStreamClass</code> to designate that the class
+ * is an enum constant.
+ *
+ * @since 1.5
+ */
+ byte SC_ENUM = 0x10;
+
+ /**
+ * Constant for use with a <code>SecurityManager</code> to check if
+ * substitution of objects is allowed.
+ */
SerializablePermission SUBSTITUTION_PERMISSION
= new SerializablePermission("enableSubstitution");
+ /**
+ * Constant for use with a <code>SecurityManager</code> to check if
+ * overriding of the <code>writeObject</code> and <code>readObject</code>
+ * methods is allowed.
+ */
SerializablePermission SUBCLASS_IMPLEMENTATION_PERMISSION
= new SerializablePermission("enableSubclassImplementation");
}
2006-05-25 Carsten Neumann <[EMAIL PROTECTED]>
* java/io/ObjectStreamConstants.java: Added API docs.
