com.facebook.stetho.inspector.elements

Class AbstractChainedDescriptor<E>

java.lang.Object

com.facebook.stetho.inspector.elements.Descriptor

com.facebook.stetho.inspector.elements.AbstractChainedDescriptor<E>

Type Parameters:

E - the class that this descriptor will be describing for DocumentProvider, Document, and ultimately DOM.

All Implemented Interfaces:

ThreadBound, ChainedDescriptor, NodeDescriptor

public abstract class AbstractChainedDescriptor<E>
extends Descriptor
implements ChainedDescriptor

This class derives from Descriptor and provides a canonical implementation of ChainedDescriptor.

This class implements the thread safety enforcement policy prescribed by ThreadBound. Namely, that Descriptor.verifyThreadAccess()} needs to be called in the prologue for every method. Your derived class SHOULD NOT call Descriptor.verifyThreadAccess()} in any of its on___() methods.

(NOTE: As an optimization, Descriptor.verifyThreadAccess() is not actually called in the prologue for every method. Instead, we rely on DocumentProvider.getNodeDescriptor(Object) calling it in order to get most of our enforcement coverage. We still call Descriptor.verifyThreadAccess() in a few important methods such as hook(Object) and unhook(Object) (anything that writes or is potentially really dangerous if misused).

Nested Class Summary

Nested classes/interfaces inherited from class com.facebook.stetho.inspector.elements.Descriptor

Descriptor.Host

Constructor Summary

Constructors

Constructor and Description
AbstractChainedDescriptor()

Method Summary

Modifier and Type	Method and Description
void	getAttributes(java.lang.Object element, AttributeAccumulator attributes)
void	getChildren(java.lang.Object element, Accumulator<java.lang.Object> children)
java.lang.String	getLocalName(java.lang.Object element)
java.lang.String	getNodeName(java.lang.Object element)
NodeType	getNodeType(java.lang.Object element)
java.lang.String	getNodeValue(java.lang.Object element)
void	getStyles(java.lang.Object element, StyleAccumulator accumulator)
void	hook(java.lang.Object element)
protected void	onGetAttributes(E element, AttributeAccumulator attributes)
protected void	onGetChildren(E element, Accumulator<java.lang.Object> children)
protected java.lang.String	onGetLocalName(E element)
protected java.lang.String	onGetNodeName(E element)
protected NodeType	onGetNodeType(E element)
java.lang.String	onGetNodeValue(E element)
protected void	onGetStyles(E element, StyleAccumulator accumulator)
protected void	onHook(E element)
protected void	onSetAttributesAsText(E element, java.lang.String text)
protected void	onUnhook(E element)
void	setAttributesAsText(java.lang.Object element, java.lang.String text)
void	setSuper(Descriptor superDescriptor)
void	unhook(java.lang.Object element)

Methods inherited from class com.facebook.stetho.inspector.elements.Descriptor

checkThreadAccess, getHost, parseSetAttributesAsTextArg, postAndWait, postAndWait, postDelayed, removeCallbacks, verifyThreadAccess

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractChainedDescriptor

public AbstractChainedDescriptor()

Method Detail

setSuper

public void setSuper(Descriptor superDescriptor)

Specified by:

setSuper in interface ChainedDescriptor

hook

public final void hook(java.lang.Object element)

Specified by:

hook in interface NodeDescriptor

onHook

protected void onHook(E element)

unhook

public final void unhook(java.lang.Object element)

Specified by:

unhook in interface NodeDescriptor

onUnhook

protected void onUnhook(E element)

getNodeType

public final NodeType getNodeType(java.lang.Object element)

Specified by:

getNodeType in interface NodeDescriptor

onGetNodeType

protected NodeType onGetNodeType(E element)

getNodeName

public final java.lang.String getNodeName(java.lang.Object element)

Specified by:

getNodeName in interface NodeDescriptor

onGetNodeName

protected java.lang.String onGetNodeName(E element)

getLocalName

public final java.lang.String getLocalName(java.lang.Object element)

Specified by:

getLocalName in interface NodeDescriptor

onGetLocalName

protected java.lang.String onGetLocalName(E element)

getNodeValue

public final java.lang.String getNodeValue(java.lang.Object element)

Specified by:

getNodeValue in interface NodeDescriptor

onGetNodeValue

public java.lang.String onGetNodeValue(E element)

getChildren

public final void getChildren(java.lang.Object element,
                              Accumulator<java.lang.Object> children)

Specified by:

getChildren in interface NodeDescriptor

onGetChildren

protected void onGetChildren(E element,
                             Accumulator<java.lang.Object> children)

getAttributes

public final void getAttributes(java.lang.Object element,
                                AttributeAccumulator attributes)

Specified by:

getAttributes in interface NodeDescriptor

onGetAttributes

protected void onGetAttributes(E element,
                               AttributeAccumulator attributes)

setAttributesAsText

public final void setAttributesAsText(java.lang.Object element,
                                      java.lang.String text)

Specified by:

setAttributesAsText in interface NodeDescriptor

onSetAttributesAsText

protected void onSetAttributesAsText(E element,
                                     java.lang.String text)

getStyles

public final void getStyles(java.lang.Object element,
                            StyleAccumulator accumulator)

Specified by:

getStyles in interface NodeDescriptor

onGetStyles

protected void onGetStyles(E element,
                           StyleAccumulator accumulator)