My copyright assignment should be on file now.
Wolfgang Baer pointed out that the two fields this patch adds (TC_ENUM,
SC_ENUM) are already on the generics branch. Should I split the patch
into 2 (one that only documents HEAD and one for the two new fields) to
simplify merges ?
Thanks,
Carsten
Carsten Neumann wrote:
>
> Hi all,
>
> in addition to the documentation I also added two fields that were added
> in 1.5 (TC_ENUM and SC_ENUM).
> Please note that my copyright assignment is in snail mail, I'll ping
> this message when the paper shuffling is finished.
>
> Thanks,
> Carsten
>
> The Changelog is:
>
> 2006-04-07 Carsten Neumann <[EMAIL PROTECTED]>
>
> * java/io/ObjectStreamConstants.java: Documented fields.
> (TC_ENUM): New field.
> (SC_ENUM): New field.
> (TC_MAX): Changed to reflect addition of TC_ENUM.
>
>
> ------------------------------------------------------------------------
>
> Index: ObjectStreamConstants.java
> ===================================================================
> RCS file: /sources/classpath/classpath/java/io/ObjectStreamConstants.java,v
> retrieving revision 1.14
> diff -u -r1.14 ObjectStreamConstants.java
> --- ObjectStreamConstants.java 22 Mar 2006 17:52:33 -0000 1.14
> +++ ObjectStreamConstants.java 6 Apr 2006 21:48:25 -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,37 +68,159 @@
> */
> 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;
>
> + /**
> + * Tag value to designate a <code>null</code> reference in the stream.
> + */
> byte TC_NULL = (byte)112; //0x70
> +
> + /**
> + * Tag value to designate a reference to an already serialized object.
> + */
> byte TC_REFERENCE = (byte)113; //0x71
> +
> + /**
> + * Tag value to designate a class descriptor is next in the stream.
> + */
> byte TC_CLASSDESC = (byte)114; //0x72
> +
> + /**
> + * Tag value to designate a new object is next in the stream.
> + */
> byte TC_OBJECT = (byte)115; //0x73
> +
> + /**
> + * Tag value to designate a new string is next in the stream.
> + */
> byte TC_STRING = (byte)116; //0x74
> +
> + /**
> + * Tag value to designate a new array is next in the stream.
> + */
> byte TC_ARRAY = (byte)117; //0x75
> +
> + /**
> + * Tag reference to designate a reference to a class.
> + */
> byte TC_CLASS = (byte)118; //0x76
> +
> + /**
> + * Tag 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
> +
> + /**
> + * Tag value to designate the end of a block of primitve data.
> + */
> byte TC_ENDBLOCKDATA = (byte)120; //0x78
> +
> + /**
> + * Tag value to designate a reset of the stream state.
> + */
> byte TC_RESET = (byte)121; //0x79
> +
> + /**
> + * Tag 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
> +
> + /**
> + * Tag value to designate an exception occured during serialization.
> + */
> byte TC_EXCEPTION = (byte)123; //0x7B
> +
> + /**
> + * Tag value to designate a long string is next in the stream.
> + */
> byte TC_LONGSTRING = (byte)124; //0x7C
> +
> + /**
> + * Tag value to designate a proxy class descriptor is next in the stream.
> + */
> byte TC_PROXYCLASSDESC = (byte)125; //0x7D
>
> + /**
> + * Tag value to designate an enum constant is next in the stream.
> + *
> + * @since 1.5
> + */
> + byte TC_ENUM = (byte)126; //0x7E
> +
> + /**
> + * The first tag value.
> + */
> byte TC_BASE = TC_NULL;
> - byte TC_MAX = TC_PROXYCLASSDESC;
> +
> + /**
> + * The last tag 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;
>
> + /**
> + * 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");
> }
