ObjectScanningObserver

All Known Implementing Classes:

AnalysisObjectScanningObserver, HeapSnapshotVerifier.ScanningObserver
```
public interface ObjectScanningObserver
```
This interface contains hooks for constant scanning events. When scanning a field there are three possible cases: the field value is a relocated pointer, the field value is null or the field value is non-null. When scanning array elements there are two possible cases: the element value is either null or the field value is non-null. The implementers of this API will call the appropriate method during scanning.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default void`	`forEmbeddedRoot(JavaConstant root, ObjectScanner.ScanReason reason)` Hook for scanned embedded root.
`default boolean`	`forNonNullArrayElement(JavaConstant array, AnalysisType arrayType, JavaConstant elementConstant, AnalysisType elementType, int elementIndex, ObjectScanner.ScanReason reason)` Hook for scanned non-null element value.
`default boolean`	`forNonNullFieldValue(JavaConstant receiver, AnalysisField field, JavaConstant fieldValue, ObjectScanner.ScanReason reason)` Hook for scanned non-null field value.
`default boolean`	`forNullArrayElement(JavaConstant array, AnalysisType arrayType, int elementIndex, ObjectScanner.ScanReason reason)` Hook for scanned null element value.
`default boolean`	`forNullFieldValue(JavaConstant receiver, AnalysisField field, ObjectScanner.ScanReason reason)` Hook for scanned null field value.
`default boolean`	`forRelocatedPointerFieldValue(JavaConstant receiver, AnalysisField field, JavaConstant fieldValue, ObjectScanner.ScanReason reason)` Hook for relocated pointer scanned field value.
`default void`	`forScannedConstant(JavaConstant scannedValue, ObjectScanner.ScanReason reason)` Hook for scanned constant.

Method Detail

forRelocatedPointerFieldValue

default boolean forRelocatedPointerFieldValue(JavaConstant receiver,
                                              AnalysisField field,
                                              JavaConstant fieldValue,
                                              ObjectScanner.ScanReason reason)

Hook for relocated pointer scanned field value.

For relocated pointers the value is only known at runtime after methods are relocated, which is pretty much the same as a field written at runtime: we do not have a constant value.

forNullFieldValue

default boolean forNullFieldValue(JavaConstant receiver,
                                  AnalysisField field,
                                  ObjectScanner.ScanReason reason)

Hook for scanned null field value.

forNonNullFieldValue

default boolean forNonNullFieldValue(JavaConstant receiver,
                                     AnalysisField field,
                                     JavaConstant fieldValue,
                                     ObjectScanner.ScanReason reason)

Hook for scanned non-null field value.

Returns:: true if value is consumed, false otherwise

forNullArrayElement

default boolean forNullArrayElement(JavaConstant array,
                                    AnalysisType arrayType,
                                    int elementIndex,
                                    ObjectScanner.ScanReason reason)

Hook for scanned null element value.

forNonNullArrayElement

default boolean forNonNullArrayElement(JavaConstant array,
                                       AnalysisType arrayType,
                                       JavaConstant elementConstant,
                                       AnalysisType elementType,
                                       int elementIndex,
                                       ObjectScanner.ScanReason reason)

Hook for scanned non-null element value.

Returns:: true if value is consumed, false otherwise

forEmbeddedRoot

default void forEmbeddedRoot(JavaConstant root,
                             ObjectScanner.ScanReason reason)

Hook for scanned embedded root.

forScannedConstant

default void forScannedConstant(JavaConstant scannedValue,
                                ObjectScanner.ScanReason reason)

Hook for scanned constant.

Interface ObjectScanningObserver