Find Usages Diff Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions 
1
  /*
2
   * Copyright 1996-2006 Sun Microsystems, Inc.  All Rights Reserved.
3
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4
   *
5
   * This code is free software; you can redistribute it and/or modify it
6
   * under the terms of the GNU General Public License version 2 only, as
7
   * published by the Free Software Foundation.  Sun designates this
8
   * particular file as subject to the "Classpath" exception as provided
9
   * by Sun in the LICENSE file that accompanied this code.
10
  *
11
  * This code is distributed in the hope that it will be useful, but WITHOUT
12
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14
  * version 2 for more details (a copy is included in the LICENSE file that
15
  * accompanied this code).
16
  *
17
  * You should have received a copy of the GNU General Public License version
18
  * 2 along with this work; if not, write to the Free Software Foundation,
19
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20
  *
21
  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22
  * CA 95054 USA or visit www.sun.com if you need additional information or
23
  * have any questions.
24
  */
25
 
26
 package java.io;
27
 
A description of a Serializable field from a Serializable class. An array of ObjectStreamFields is used to declare the Serializable fields of a class.

Author(s):
Mike Warres
Roger Riggs
Since:
1.2
See also:
ObjectStreamClass
38
 
39
 public class ObjectStreamField
40
     implements Comparable<Object>
41
 {

    
field name
43
 
44
     private final String name;
    
canonical JVM signature of field type
45
 
46
     private final String signature;
    
field type (Object.class if unknown non-primitive type)
47
 
48
     private final Class type;
    
whether or not to (de)serialize field values as unshared
49
 
50
     private final boolean unshared;
    
corresponding reflective field object, if any
51
 
52
     private final Field field;
    
offset of field value in enclosing field group
53
 
54
     private int offset = 0;

    
Create a Serializable field with the specified type. This field should be documented with a serialField tag.

Parameters:
name the name of the serializable field
type the Class object of the serializable field
62
 
63
     public ObjectStreamField(String name, Class<?> type) {
64
         this(name, type, false);
65
     }

    
Creates an ObjectStreamField representing a serializable field with the given name and type. If unshared is false, values of the represented field are serialized and deserialized in the default manner--if the field is non-primitive, object values are serialized and deserialized as if they had been written and read by calls to writeObject and readObject. If unshared is true, values of the represented field are serialized and deserialized as if they had been written and read by calls to writeUnshared and readUnshared.

Parameters:
name field name
type field type
unshared if false, write/read field values in the same manner as writeObject/readObject; if true, write/read in the same manner as writeUnshared/readUnshared
Since:
1.4
83
 
84
     public ObjectStreamField(String name, Class<?> type, boolean unshared) {
85
         if (name == null) {
86
             throw new NullPointerException();
87
         }
88
         this. = name;
89
         this. = type;
90
         this. = unshared;
91
          = ObjectStreamClass.getClassSignature(type).intern();
92
          = null;
93
     }

    
Creates an ObjectStreamField representing a field with the given name, signature and unshared setting. 
98
 
99
     ObjectStreamField(String name, String signature, boolean unshared) {
100
        if (name == null) {
101
            throw new NullPointerException();
102
        }
103
        this. = name;
104
        this. = signature.intern();
105
        this. = unshared;
106
         = null;
108
        switch (signature.charAt(0)) {
109
            case 'Z':  = .; break;
110
            case 'B':  = .; break;
111
            case 'C':  = .; break;
112
            case 'S':  = .; break;
113
            case 'I':  = .; break;
114
            case 'J':  = .; break;
115
            case 'F':  = .; break;
116
            case 'D':  = .; break;
117
            case 'L':
118
            case '[':  = Object.class; break;
119
            default: throw new IllegalArgumentException("illegal signature");
120
        }
121
    }

    
Creates an ObjectStreamField representing the given field with the specified unshared setting. For compatibility with the behavior of earlier serialization implementations, a "showType" parameter is necessary to govern whether or not a getType() call on this ObjectStreamField (if non-primitive) will return Object.class (as opposed to a more specific reference type). 
131
    ObjectStreamField(Field field, boolean unshared, boolean showType) {
132
        this. = field;
133
        this. = unshared;
134
         = field.getName();
135
        Class ftype = field.getType();
136
         = (showType || ftype.isPrimitive()) ? ftype : Object.class;
137
         = ObjectStreamClass.getClassSignature(ftype).intern();
138
    }

    
Get the name of this field.

Returns:
a String representing the name of the serializable field
146
    public String getName() {
147
        return ;
148
    }

    
Get the type of the field. If the type is non-primitive and this ObjectStreamField was obtained from a deserialized ObjectStreamClass instance, then Object.class is returned. Otherwise, the Class object for the type of the field is returned.

Returns:
a Class object representing the type of the serializable field
160
    public Class<?> getType() {
161
        return ;
162
    }

    
Returns character encoding of field type. The encoding is as follows: 
 B            byte
 C            char
 D            double
 F            float
 I            int
 J            long
 L            class or interface
 S            short
 Z            boolean
 [            array

Returns:
the typecode of the serializable field
181
    // REMIND: deprecate?
182
    public char getTypeCode() {
183
        return .charAt(0);
184
    }

    
Return the JVM type signature.

Returns:
null if this field has a primitive type.
191
    // REMIND: deprecate?
192
    public String getTypeString() {
193
        return isPrimitive() ? null : ;
194
    }

    
Offset of field within instance data.

Returns:
the offset of this field
See also:
setOffset(int)
202
    // REMIND: deprecate?
203
    public int getOffset() {
204
        return ;
205
    }

    
Offset within instance data.

Parameters:
offset the offset of the field
See also:
getOffset()
213
    // REMIND: deprecate?
214
    protected void setOffset(int offset) {
215
        this. = offset;
216
    }

    
Return true if this field has a primitive type.

Returns:
true if and only if this field corresponds to a primitive type
223
    // REMIND: deprecate?
224
    public boolean isPrimitive() {
225
        char tcode = .charAt(0);
226
        return ((tcode != 'L') && (tcode != '['));
227
    }

    
Returns boolean value indicating whether or not the serializable field represented by this ObjectStreamField instance is unshared.

Since:
1.4
235
    public boolean isUnshared() {
236
        return ;
237
    }

    
Compare this field with another ObjectStreamField. Return -1 if this is smaller, 0 if equal, 1 if greater. Types that are primitives are "smaller" than object types. If equal, the field names are compared. 
245
    // REMIND: deprecate?
246
    public int compareTo(Object obj) {
247
        ObjectStreamField other = (ObjectStreamField) obj;
248
        boolean isPrim = isPrimitive();
249
        if (isPrim != other.isPrimitive()) {
250
            return isPrim ? -1 : 1;
251
        }
252
        return .compareTo(other.name);
253
    }

    
Return a string that describes this field. 
258
    public String toString() {
259
        return  + ' ' + ;
260
    }

    
Returns field represented by this ObjectStreamField, or null if ObjectStreamField is not associated with an actual field. 
266
    Field getField() {
267
        return ;
268
    }

    
Returns JVM type signature of field (similar to getTypeString, except that signature strings are returned for primitive fields as well). 
274
    String getSignature() {
275
        return ;
276
    }
New to GrepCode? Check out our FAQ X