author | chegar |
Thu, 17 Oct 2019 20:54:25 +0100 | |
branch | datagramsocketimpl-branch |
changeset 58679 | 9c3209ff7550 |
parent 58678 | 9cf78a70fa4f |
parent 58026 | 1e3f58d409f7 |
permissions | -rw-r--r-- |
57800
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
1 |
/* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
2 |
* Copyright (c) 2018, 2019, Oracle and/or its affiliates. All rights reserved. |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
4 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
5 |
* This code is free software; you can redistribute it and/or modify it |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
7 |
* published by the Free Software Foundation. Oracle designates this |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
8 |
* particular file as subject to the "Classpath" exception as provided |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
10 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
15 |
* accompanied this code). |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
16 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
17 |
* You should have received a copy of the GNU General Public License version |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
20 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
22 |
* or visit www.oracle.com if you need additional information or have any |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
23 |
* questions. |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
24 |
*/ |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
25 |
|
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
26 |
package java.io; |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
27 |
|
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
28 |
import java.lang.annotation.*; |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
29 |
|
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
30 |
/** |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
31 |
* Indicates that an annotated field or method is part of the {@linkplain |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
32 |
* Serializable serialization mechanism} defined by the |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
33 |
* <cite>Java Object Serialization Specification</cite>. This |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
34 |
* annotation type is intended to allow compile-time checking of |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
35 |
* serialization-related declarations, analogous to the checking |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
36 |
* enabled by the {@link java.lang.Override} annotation type to |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
37 |
* validate method overriding. {@code Serializable} classes are encouraged to |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
38 |
* use <code>@Serial</code> annotations to help a compiler catch |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
39 |
* mis-declared serialization-related fields and methods, |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
40 |
* mis-declarations that may otherwise be difficult to detect. |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
41 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
42 |
* <p>Specifically, annotations of this type should be |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
43 |
* applied to serialization-related methods and fields in classes |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
44 |
* declared to be {@code Serializable}. The five serialization-related |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
45 |
* methods are: |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
46 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
47 |
* <ul> |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
48 |
* <li>{@code private void writeObject(java.io.ObjectOutputStream stream) throws IOException} |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
49 |
* <li>{@code private void readObject(java.io.ObjectInputStream stream) throws IOException, ClassNotFoundException} |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
50 |
* <li>{@code private void readObjectNoData() throws ObjectStreamException} |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
51 |
* <li><i>ANY-ACCESS-MODIFIER</i> {@code Object writeReplace() throws ObjectStreamException} |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
52 |
* <li><i>ANY-ACCESS-MODIFIER</i> {@code Object readResolve() throws ObjectStreamException} |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
53 |
* </ul> |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
54 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
55 |
* The two serialization-related fields are: |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
56 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
57 |
* <ul> |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
58 |
* <li>{@code private static final ObjectStreamField[] serialPersistentFields} |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
59 |
* <li>{@code private static final long serialVersionUID} |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
60 |
* </ul> |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
61 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
62 |
* Compilers are encouraged to validate that a method or field marked with a |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
63 |
* <code>@Serial</code> annotation is one of the defined serialization-related |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
64 |
* methods or fields declared in a meaningful context and issue a warning |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
65 |
* if that is not the case. |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
66 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
67 |
* <p>It is a semantic error to apply this annotation to other fields or methods, including: |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
68 |
* <ul> |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
69 |
* <li>fields or methods in a class that is not {@code Serializable} |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
70 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
71 |
* <li>fields or methods of the proper structural declaration, but in |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
72 |
* a type where they are ineffectual. For example, {@code enum} types |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
73 |
* are defined to have a {@code serialVersionUID} of {@code 0L} so a |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
74 |
* {@code serialVersionUID} field declared in an {@code enum} type is |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
75 |
* ignored. The five serialization-related methods identified above |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
76 |
* are likewise ignored for an {@code enum} type. |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
77 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
78 |
* <li>in a class that is {@code Externalizable}: |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
79 |
* <ul> |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
80 |
* <li> method declarations of {@code writeObject}, {@code |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
81 |
* readObject}, and {@code readObjectNoData} |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
82 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
83 |
* <li>a field declaration for {@code serialPersistentFields} |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
84 |
* </ul> |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
85 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
86 |
* While the {@code Externalizable} interface extends {@code |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
87 |
* Serializable}, the three methods and one field above are |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
88 |
* <em>not</em> used for externalizable classes. |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
89 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
90 |
* </ul> |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
91 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
92 |
* Note that serialization mechanism accesses its designated fields |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
93 |
* and methods reflectively and those fields and methods may appear |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
94 |
* otherwise unused in a {@code Serializable} class. |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
95 |
* |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
96 |
* @see Serializable |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
97 |
* @see Externalizable |
58026 | 98 |
* @since 14 |
57800
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
99 |
*/ |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
100 |
@Target({ElementType.METHOD, ElementType.FIELD}) |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
101 |
@Retention(RetentionPolicy.SOURCE) |
0abdc5a425dd
8202385: Annotation to mark serial-related fields and methods
darcy
parents:
diff
changeset
|
102 |
public @interface Serial {} |