com.crawljax.core.state

Class StateVertex

java.lang.Object

com.crawljax.core.state.StateVertex

All Implemented Interfaces:

Serializable

public class StateVertex
extends Object
implements Serializable

The state vertex class which represents a state in the browser. This class implements the Iterable interface because on a StateVertex it is possible to iterate over the possible CandidateElements found in this state. When iterating over the possible candidate elements every time a candidate is returned its removed from the list so it is a one time only access to the candidates.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	INDEX_ID

Constructor Summary

Constructors

Constructor and Description
StateVertex(int id) Default constructor to support saving instances of this class as an XML.
StateVertex(int id, String name, String dom) Creates a current state without an url and the stripped dom equals the dom.
StateVertex(int id, String url, String name, String dom, String strippedDom) Defines a State.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Compare this vertex to a other StateVertex.
Document	getDocument()
String	getDom() Retrieve the DOM String.
int	getDomSize() Return the size of the DOM in bytes.
int	getId()
String	getName() Retrieve the name of the StateVertex.
String	getStrippedDom()
String	getUrl()
com.google.common.collect.ImmutableList<Eventable>	getUsedEventables()
int	hashCode() Returns a hashcode.
void	registerEventable(Eventable eventable)
void	setDom(String dom)
void	setName(String name)
String	toString() Returns the name of this state as string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INDEX_ID

public static final int INDEX_ID

See Also:

Constant Field Values

Constructor Detail

StateVertex

public StateVertex(int id)

Default constructor to support saving instances of this class as an XML.

StateVertex

public StateVertex(int id,
           String name,
           String dom)

Creates a current state without an url and the stripped dom equals the dom.

Parameters:

name - the name of the state

dom - the current DOM tree of the browser

StateVertex

public StateVertex(int id,
           String url,
           String name,
           String dom,
           String strippedDom)

Defines a State.

Parameters:

url - the current url of the state

name - the name of the state

dom - the current DOM tree of the browser

strippedDom - the stripped dom by the OracleComparators

Method Detail

getName

public String getName()

Retrieve the name of the StateVertex.

Returns:

the name of the StateVertex

getDom

public String getDom()

Retrieve the DOM String.

Returns:

the dom for this state

getStrippedDom

public String getStrippedDom()

Returns:

the stripped dom by the oracle comparators

getUrl

public String getUrl()

Returns:

the url

hashCode

public int hashCode()

Returns a hashcode. Uses reflection to determine the fields to test.

Overrides:

hashCode in class Object

Returns:

the hashCode of this StateVertex

equals

public boolean equals(Object obj)

Compare this vertex to a other StateVertex.

Overrides:

equals in class Object

Parameters:

obj - the Object to compare this vertex

Returns:

Return true if equal. Uses reflection.

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Returns the name of this state as string.

Overrides:

toString in class Object

Returns:

a string representation of the current StateVertex

getDomSize

public int getDomSize()

Return the size of the DOM in bytes.

Returns:

the size of the dom

getId

public int getId()

Returns:

the id. This is guaranteed to be unique per state.

setName

public void setName(String name)

Parameters:

name - the name to set

setDom

public void setDom(String dom)

Parameters:

dom - the dom to set

getDocument

public Document getDocument()
                     throws IOException

Returns:

a Document instance of the dom string.

Throws:

IOException - if an exception is thrown.

registerEventable

public void registerEventable(Eventable eventable)

Parameters:

eventable - The eventable that was clicked in this state.

getUsedEventables

public com.google.common.collect.ImmutableList<Eventable> getUsedEventables()