classdesc

java.lang.Object
- jdeserialize.contentbase
- - jdeserialize.classdesc

All Implemented Interfaces:

content
```
public class classdesc
extends contentbase
```
Represents the entire serialized prototype of the class, including all fields, inner classes, class annotations, and inheritance hierarchy. This includes proxy class descriptions.

Generally, this class is used to represent the type of an instance written to an ObjectOutputStream with its writeObject() method, or of a related array or field type. However, there's a notable exception: when instances of type java.io.ObjectStreamClass are written with writeObject(), only their class description is written (cf. Object Serialization Specification, 4.3). They will be represented with an instance of classdesc as well.

Field Summary

Fields
Modifier and Type	Field and Description
`java.util.List<content>`	`annotations` List of annotation objects; these are not Java annotations, but data written by the annotateClass(Class
`classdesctype`	`classtype` Type of the class being represented; either a normal class or a proxy class.
`byte`	`descflags` Description flags byte; this should be a mask of values from the ObjectStreamContants class.
`java.util.Set<java.lang.String>`	`enumconstants` Set of enum constants, for enum classes.
`field[]`	`fields` Array of fields in the class, in the order serialized by the stream writer.
`java.util.List<classdesc>`	`innerclasses` List of inner classes, in the order serialized by the stream writer.
`java.lang.String[]`	`interfaces` Array of serialized interfaces, in the order serialized by the stream writer.
`private boolean`	`isInnerClass`
`private boolean`	`isLocalInnerClass`
`private boolean`	`isStaticMemberClass`
`java.lang.String`	`name` Class name.
`long`	`serialVersionUID` Serial version UID, as recorded in the stream.
`classdesc`	`superclass` The superclass of the object, if available.

Fields inherited from class jdeserialize.contentbase
handle, isExceptionObject, type

Fields inherited from interface jdeserialize.content
INDENT, NEW_LINE

Constructor Summary

Constructors
Constructor and Description

classdesc(classdesctype classtype)
Constructor.

Constructors
Constructor and Description
`classdesc(classdesctype classtype)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEnum(java.lang.String constval)` Add an enum constant to the description's set.
`void`	`addInnerClass(classdesc cd)` Add an inner class to the description's list.
`private java.lang.String`	`closingJsonSeq(java.lang.StringBuffer sb, java.lang.String indentation)` Removes the indentation, inserts new line and closing curly brackets in sb Does this sequence twice for closing the classdesc toJson
`private void`	`extendsToJson(java.lang.StringBuffer sb, classdesc superclass)` Appends the extends clausule to the input StringBuffer.
`void`	`getHierarchy(java.util.ArrayList<classdesc> classes)` Generates a list of all class descriptions in this class's hierarchy, in the order described by the Object Stream Serialization Protocol.
`private void`	`interfacesToJson(java.lang.StringBuffer sb, java.lang.String[] interfaces)` Appends the implements clausule to the input StringBuffer.
`boolean`	`isArrayClass()` Determines whether this is an array type.
`boolean`	`isInnerClass()` True if this class has been determined to be an inner class; this determination is generally made by connectMemberClasses().
`boolean`	`isLocalInnerClass()` True if this class has been determined to be a local inner class; this determination is generally made by connectMemberClasses().
`boolean`	`isStaticMemberClass()` True if this class has been determined to be a static member class; this determination is generally made by connectMemberClasses().
`void`	`setIsInnerClass(boolean nis)` Sets the value that denotes that the class is an inner class.
`void`	`setIsLocalInnerClass(boolean nis)` Sets the flag that denotes whether this class is a local inner class.
`void`	`setIsStaticMemberClass(boolean nis)` Sets the flag that denotes whether this class is a static member class.
`java.lang.String`	`toJson(java.lang.String indentation, java.util.Map<classdesc,java.util.Map<field,java.lang.Object>> fielddata, boolean child)` Analogy for toString method; however, outputs its string in json formatting.
`java.lang.String`	`toString()`
`void`	`validate()` Performs extra object-specific validity checks.

Methods inherited from class jdeserialize.contentbase
getHandle, getType, isExceptionObject, setIsExceptionObject

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - classtype
```
public classdesctype classtype
```
    Type of the class being represented; either a normal class or a proxy class.
  - name
```
public java.lang.String name
```
    Class name.
  - serialVersionUID
```
public long serialVersionUID
```
    Serial version UID, as recorded in the stream.
  - descflags
```
public byte descflags
```
    Description flags byte; this should be a mask of values from the ObjectStreamContants class. Refer to chapter 6 of the Object Stream Serialization Protocol for details.
  - fields
```
public field[] fields
```
    Array of fields in the class, in the order serialized by the stream writer.
  - innerclasses
```
public java.util.List<classdesc> innerclasses
```
    List of inner classes, in the order serialized by the stream writer.
  - annotations
```
public java.util.List<content> annotations
```
    List of annotation objects; these are *not* Java annotations, but data written by the
```
 annotateClass(Class) and annotateProxyClass(Class)
 
 
 methods of an ObjectOutputStream.
```
  - superclass
```
public classdesc superclass
```
    The superclass of the object, if available.
  - interfaces
```
public java.lang.String[] interfaces
```
    Array of serialized interfaces, in the order serialized by the stream writer.
  - enumconstants
```
public java.util.Set<java.lang.String> enumconstants
```
    Set of enum constants, for enum classes.
  - isInnerClass
```
private boolean isInnerClass
```
  - isLocalInnerClass
```
private boolean isLocalInnerClass
```
  - isStaticMemberClass
```
private boolean isStaticMemberClass
```
- Constructor Detail
  - classdesc
```
public classdesc(classdesctype classtype)
```
    Constructor.
    
    Parameters:
    
    classtype - the type of the class
- Method Detail
  - isInnerClass
```
public boolean isInnerClass()
```
    True if this class has been determined to be an inner class; this determination is generally made by connectMemberClasses().
    
    Returns:
    
    true if the class is an inner class
  - setIsInnerClass
```
public void setIsInnerClass(boolean nis)
```
    Sets the value that denotes that the class is an inner class.
    
    Parameters:
    
    nis - the value to set
  - isLocalInnerClass
```
public boolean isLocalInnerClass()
```
    True if this class has been determined to be a local inner class; this determination is generally made by connectMemberClasses().
    
    Returns:
    
    true if the class is a local inner class
  - setIsLocalInnerClass
```
public void setIsLocalInnerClass(boolean nis)
```
    Sets the flag that denotes whether this class is a local inner class.
    
    Parameters:
    
    nis - the value to set
  - isStaticMemberClass
```
public boolean isStaticMemberClass()
```
    True if this class has been determined to be a static member class; this determination is generally made by connectMemberClasses().
    
    Note that in some cases, static member classes' descriptions will be serialized even though their enclosing class is not. In these cases, this may return false. See connectMemberClasses() for details.
    
    Returns:
    
    true if this is a static member class
  - setIsStaticMemberClass
```
public void setIsStaticMemberClass(boolean nis)
```
    Sets the flag that denotes whether this class is a static member class.
    
    Parameters:
    
    nis - the value to set
  - addInnerClass
```
public void addInnerClass(classdesc cd)
```
    Add an inner class to the description's list.
    
    Parameters:
    
    cd - inner class to add
  - addEnum
```
public void addEnum(java.lang.String constval)
```
    Add an enum constant to the description's set.
    
    Parameters:
    
    constval - enum constant string
  - isArrayClass
```
public boolean isArrayClass()
```
    Determines whether this is an array type.
    
    Returns:
    
    true if this is an array type.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getHierarchy
```
public void getHierarchy(java.util.ArrayList<classdesc> classes)
```
    Generates a list of all class descriptions in this class's hierarchy, in the order described by the Object Stream Serialization Protocol. This is the order in which fields are read from the stream.
    
    Parameters:
    
    classes - a list to be filled in with the hierarchy
  - validate
```
public void validate()
              throws ValidityException
```
    Description copied from interface: content
    
    Performs extra object-specific validity checks.
    
    Specified by:
    
    validate in interface content
    
    Overrides:
    
    validate in class contentbase
    
    Throws:
    
    ValidityException - if the object's state is invalid
  - toJson
```
public java.lang.String toJson(java.lang.String indentation,
                               java.util.Map<classdesc,java.util.Map<field,java.lang.Object>> fielddata,
                               boolean child)
```
    Description copied from interface: content
    
    Analogy for toString method; however, outputs its string in json formatting. Returns the exact json representation of object with indentation.
    
    Inherited by multiple classes via contentbase, often calls itself for another object
    
    Specified by:
    
    toJson in interface content
    
    Overrides:
    
    toJson in class contentbase
    
    Parameters:
    
    indentation - starting indentation for json output
    
    fielddata - used when calling this method for inner instances so the instance has info about its variables. Instance info is saved in another content space than info about its field variables, so it must be provided by parameter to inner instances
    
    child - tells that the instance is child of another because of indentation
    
    Returns:
    
    The string in json format representing this instance
  - closingJsonSeq
```
private java.lang.String closingJsonSeq(java.lang.StringBuffer sb,
                                        java.lang.String indentation)
```
    Removes the indentation, inserts new line and closing curly brackets in sb Does this sequence twice for closing the classdesc toJson
    
    Parameters:
    
    sb - StringBuffer where the closing sequence will be appended
    
    indentation - Indentation to be changed
    
    Returns:
    
    The edited indentation String
  - extendsToJson
```
private void extendsToJson(java.lang.StringBuffer sb,
                           classdesc superclass)
```
    Appends the extends clausule to the input StringBuffer. Only if superclass presented
    
    Parameters:
    
    sb - StringBuffer to append the string to
    
    superclass - superclass instance which name will be appended
  - interfacesToJson
```
private void interfacesToJson(java.lang.StringBuffer sb,
                              java.lang.String[] interfaces)
```
    Appends the implements clausule to the input StringBuffer. Only if any interface implementation presented
    
    Parameters:
    
    sb - StringBuffer to append the string to
    
    interfaces - Array of implemented interface names

Class classdesc

Field Summary

Fields inherited from class jdeserialize.contentbase

Fields inherited from interface jdeserialize.content

Constructor Summary

Method Summary

Methods inherited from class jdeserialize.contentbase

Methods inherited from class java.lang.Object

Field Detail

classtype

name

serialVersionUID

descflags

fields

innerclasses

annotations

superclass

interfaces

enumconstants

isInnerClass

isLocalInnerClass

isStaticMemberClass

Constructor Detail

classdesc

Method Detail

isInnerClass

setIsInnerClass

isLocalInnerClass

setIsLocalInnerClass

isStaticMemberClass

setIsStaticMemberClass

addInnerClass

addEnum

isArrayClass

toString

getHierarchy

validate

toJson

closingJsonSeq

extendsToJson

interfacesToJson