jdk/src/java.base/share/specs/serialization/index.md
author rriggs
Fri, 12 May 2017 15:15:43 -0400
changeset 45138 ddcafe0d0ea3
parent 44787 0b323ea6d5ad
child 45142 be2c212f16dd
permissions -rw-r--r--
8180082: Broken javadoc links Reviewed-by: mchung, bpb, chegar, ihse
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
44787
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
     1
---
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
     2
# Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
     3
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
     4
#
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
     5
# This code is free software; you can redistribute it and/or modify it
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
     6
# under the terms of the GNU General Public License version 2 only, as
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
     7
# published by the Free Software Foundation.
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
     8
#
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
     9
# This code is distributed in the hope that it will be useful, but WITHOUT
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    10
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    11
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    12
# version 2 for more details (a copy is included in the LICENSE file that
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    13
# accompanied this code).
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    14
#
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    15
# You should have received a copy of the GNU General Public License version
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    16
# 2 along with this work; if not, write to the Free Software Foundation,
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    17
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    18
#
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    19
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    20
# or visit www.oracle.com if you need additional information or have any
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    21
# questions.
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    22
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    23
include-before: 'CONTENTS | PREV | [NEXT](changelog.html)'
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    24
include-after: 'CONTENTS | PREV | [NEXT](changelog.html)'
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    25
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    26
title: 'Java Object Serialization Specification: Contents'
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    27
---
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    28
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    29
-------------------------------------------------------------------------------
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    30
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    31
## Table of Contents
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    32
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    33
### 0 [Change History](changelog.html)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    34
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    35
### 1 [System Architecture](serial-arch.html)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    36
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    37
-   1.1 [Overview](serial-arch.html#overview)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    38
-   1.2 [Writing to an Object
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    39
    Stream](serial-arch.html#writing-to-an-object-stream)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    40
-   1.3 [Reading from an Object
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    41
    Stream](serial-arch.html#reading-from-an-object-stream)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    42
-   1.4 [Object Streams as
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    43
    Containers](serial-arch.html#object-streams-as-containers)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    44
-   1.5 [Defining Serializable Fields for a
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    45
    Class](serial-arch.html#defining-serializable-fields-for-a-class)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    46
-   1.6 [Documenting Serializable Fields and Data for a
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    47
    Class](serial-arch.html#documenting-serializable-fields-and-data-for-a-class)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    48
-   1.7 [Accessing Serializable Fields of a
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    49
    Class](serial-arch.html#accessing-serializable-fields-of-a-class)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    50
-   1.8 [The ObjectOutput
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    51
    Interface](serial-arch.html#the-objectoutput-interface)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    52
-   1.9 [The ObjectInput Interface](serial-arch.html#the-objectinput-interface)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    53
-   1.10 [The Serializable
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    54
    Interface](serial-arch.html#the-serializable-interface)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    55
-   1.11 [The Externalizable
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    56
    Interface](serial-arch.html#the-externalizable-interface)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    57
-   1.12 [Serialization of Enum
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    58
    Constants](serial-arch.html#serialization-of-enum-constants)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    59
-   1.13 [Protecting Sensitive
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    60
    Information](serial-arch.html#protecting-sensitive-information)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    61
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    62
### 2 [Object Output Classes](output.html)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    63
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    64
-   2.1 [The ObjectOutputStream
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    65
    Class](output.html#the-objectoutputstream-class)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    66
-   2.2 [The ObjectOutputStream.PutField
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    67
    Class](output.html#the-objectoutputstream.putfield-class)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    68
-   2.3 [The writeObject Method](output.html#the-writeobject-method)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    69
-   2.4 [The writeExternal Method](output.html#the-writeexternal-method)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    70
-   2.5 [The writeReplace Method](output.html#the-writereplace-method)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    71
-   2.6 [The useProtocolVersion
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    72
    Method](output.html#the-useprotocolversion-method)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    73
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    74
### 3 [Object Input Classes](input.html)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    75
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    76
-   3.1 [The ObjectInputStream Class](input.html#the-objectinputstream-class)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    77
-   3.2 [The ObjectInputStream.GetField
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    78
    Class](input.html#the-objectinputstream.getfield-class)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    79
-   3.3 [The ObjectInputValidation
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    80
    Interface](input.html#the-objectinputvalidation-interface)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    81
-   3.4 [The readObject Method](input.html#the-readobject-method)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    82
-   3.5 [The readObjectNoData Method](input.html#the-readobjectnodata-method)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    83
-   3.6 [The readExternal Method](input.html#the-readexternal-method)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    84
-   3.7 [The readResolve Method](input.html#the-readresolve-method)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    85
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    86
### 4 [Class Descriptors](class.html)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    87
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    88
-   4.1 [The ObjectStreamClass Class](class.html#the-objectstreamclass-class)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    89
-   4.2 [Dynamic Proxy Class
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    90
    Descriptors](class.html#dynamic-proxy-class-descriptors)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    91
-   4.3 [Serialized Form](class.html#serialized-form)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    92
-   4.4 [The ObjectStreamField Class](class.html#the-objectstreamfield-class)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    93
-   4.5 [Inspecting Serializable
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    94
    Classes](class.html#inspecting-serializable-classes)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    95
-   4.6 [Stream Unique Identifiers](class.html#stream-unique-identifiers)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    96
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    97
### 5 [Versioning of Serializable Objects](version.html)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    98
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
    99
-   5.1 [Overview](version.html#overview)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   100
-   5.2 [Goals](version.html#goals)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   101
-   5.3 [Assumptions](version.html#assumptions)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   102
-   5.4 [Who's Responsible for Versioning of
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   103
    Streams](version.html#whos-responsible-for-versioning-of-streams)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   104
-   5.5 [Compatible Java Type
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   105
    Evolution](version.html#compatible-java-type-evolution)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   106
-   5.6 [Type Changes Affecting
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   107
    Serialization](version.html#type-changes-affecting-serialization)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   108
    -   5.6.1 [Incompatible Changes](version.html#incompatible-changes)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   109
    -   5.6.2 [Compatible Changes](version.html#compatible-changes)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   110
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   111
### 6 [Object Serialization Stream Protocol](protocol.html)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   112
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   113
-   6.1 [Overview](protocol.html#overview)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   114
-   6.2 [Stream Elements](protocol.html#stream-elements)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   115
-   6.3 [Stream Protocol Versions](protocol.html#stream-protocol-versions)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   116
-   6.4 [Grammar for the Stream
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   117
    Format](protocol.html#grammar-for-the-stream-format)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   118
    -   6.4.1 [Rules of the Grammar](protocol.html#rules-of-the-grammar)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   119
    -   6.4.2 [Terminal Symbols and
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   120
        Constants](protocol.html#terminal-symbols-and-constants)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   121
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   122
### A [Security in Object Serialization](security.html)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   123
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   124
### B [Exceptions In Object Serialization](exceptions.html)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   125
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   126
### C [Example of Serializable Fields](examples.html)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   127
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   128
-   [C.1 Example Alternate Implementation of
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   129
    `java.io.File`](examples.html#c.1-example-alternate-implementation-of-java.io.file)
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   130
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   131
-------------------------------------------------------------------------------
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   132
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   133
*[Copyright](../../../legal/SMICopyright.html) © 2005, 2017, Oracle
0b323ea6d5ad 8179022: Add serialization spec as markdown
ihse
parents:
diff changeset
   134
and/or its affiliates. All rights reserved.*