Interface UnmarshallingObjectInputFilter.FilterInfo

Enclosing interface:
UnmarshallingObjectInputFilter

public static interface UnmarshallingObjectInputFilter.FilterInfo
FilterInfo provides access to information about the current object being deserialized and the status of the Unmarshaller
  • Method Summary

    Modifier and Type
    Method
    Description
    long
    Returns the number of array elements when deserializing an array of the class.
    long
    Returns the current depth.
    long
    Returns the current number of object references.
    long
    Returns the current number of bytes consumed.
    Gets the class of an object being deserialized.
  • Method Details

    • getUnmarshalledClass

      Class<?> getUnmarshalledClass()
      Gets the class of an object being deserialized. For arrays, it is the array type. For example, the array class name of a 2 dimensional array of strings is "[[Ljava.lang.String;". To check the array's element type, iteratively use Class.getComponentType while the result is an array and then check the class. The serialClass is null in the case where a new object is not being created and to give the filter a chance to check the depth, number of references to existing objects, and the stream size.
      Returns:
      class of an object being deserialized; may be null
    • getArrayLength

      long getArrayLength()
      Returns the number of array elements when deserializing an array of the class.
      Returns:
      the non-negative number of array elements when deserializing an array of the class, otherwise -1
    • getDepth

      long getDepth()
      Returns the current depth. The depth starts at 1 and increases for each nested object and decrements when each nested object returns.
      Returns:
      the current depth
    • getReferences

      long getReferences()
      Returns the current number of object references.
      Returns:
      the non-negative current number of object references
    • getStreamBytes

      long getStreamBytes()
      Returns the current number of bytes consumed.
      Returns:
      the non-negative current number of bytes consumed