org.jemmy.lookup

Class AbstractLookup<CONTROL>

java.lang.Object

org.jemmy.lookup.AbstractParent<CONTROL>

org.jemmy.lookup.AbstractLookup<CONTROL>

Type Parameters:

CONTROL - todo document

All Implemented Interfaces:

ControlInterface, Parent<CONTROL>, TypeControlInterface<CONTROL>, Lookup<CONTROL>

Direct Known Subclasses:

HierarchyLookup, PlainLookup

public abstract class AbstractLookup<CONTROL>
extends AbstractParent<CONTROL>
implements Lookup<CONTROL>

Default implementation of Lookup. Regularly, it is enough just override this implementation and allow it to handle sub-lookups creation.

Author:

shura

See Also:

lookup(org.jemmy.lookup.LookupCriteria), lookup(java.lang.Class, org.jemmy.lookup.LookupCriteria)

Field Summary

Fields

Modifier and Type	Field and Description
static String	OUTPUT Identifies output where lookup progress is printed.

Fields inherited from interface org.jemmy.lookup.Lookup

WAIT_CONTROL_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
AbstractLookup(Environment env, Class<CONTROL> controlClass, LookupCriteria<CONTROL> criteria, Wrapper wrapper) This actual lookup logic is delegated to getCildren(java.lang.Object) method

Method Summary

Modifier and Type	Method and Description
<INTERFACE extends ControlInterface> INTERFACE	as(Class<INTERFACE> interfaceClass) Same as wrap().as(interfaceClass)
<TYPE,INTERFACE extends TypeControlInterface<TYPE>> INTERFACE	as(Class<INTERFACE> interfaceClass, Class<TYPE> type) Same as wrap().as(interfaceClass, type)
<INTERFACE extends ControlInterface> INTERFACE	as(int index, Class<INTERFACE> interfaceClass) Same as wrap(index).as(interfaceClass)
<TYPE,INTERFACE extends TypeControlInterface<TYPE>> INTERFACE	as(int index, Class<INTERFACE> interfaceClass, Class<TYPE> type) Same as wrap(index).as(interfaceClass, type)
protected boolean	check(CONTROL control)
void	dump(PrintStream out)
protected abstract void	dump(PrintStream out, Lookup<? extends CONTROL> lookup)
protected void	dumpOne(PrintStream out, CONTROL obj, String prefix)
CONTROL	get() Same as get(0)
CONTROL	get(int index) Returns one of the found UI controls itself.
Class<CONTROL>	getType()
<T extends CONTROL> Lookup<T>	lookup(Class<T> controlClass, LookupCriteria<T> criteria) Searcher the hierarchy for objects extending ST which fit the criteria.
Lookup<CONTROL>	lookup(LookupCriteria<CONTROL> criteria) Searcher the hierarchy for objects extending T which fit the criteria.
int	size() Gets the number of controls which fit criteria.
Lookup<? extends CONTROL>	wait(int count) Waits for certain number of controls to fit criteria.
Wrap<? extends CONTROL>	wrap() Same as wrap(0)
Wrap<? extends CONTROL>	wrap(int index) Returns Wrap of the control with specified index

Methods inherited from class org.jemmy.lookup.AbstractParent

lookup, lookup

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jemmy.interfaces.Parent

lookup, lookup

Field Detail

OUTPUT

public static final String OUTPUT

Identifies output where lookup progress is printed.

See Also:

Environment.getOutput(java.lang.String), wait(int), size()

Constructor Detail

AbstractLookup

public AbstractLookup(Environment env,
                      Class<CONTROL> controlClass,
                      LookupCriteria<CONTROL> criteria,
                      Wrapper wrapper)

This actual lookup logic is delegated to getCildren(java.lang.Object) method

Parameters:

env - todo document

controlClass - todo document

criteria - todo document

wrapper - todo document

See Also:

getChildren(java.lang.Object)

Method Detail

lookup

public <T extends CONTROL> Lookup<T> lookup(Class<T> controlClass,
                                            LookupCriteria<T> criteria)

Description copied from interface: Parent

Searcher the hierarchy for objects extending ST which fit the criteria.

Specified by:

lookup in interface Parent<CONTROL>

Type Parameters:

T - todo document

Parameters:

controlClass - todo document

criteria - todo document

Returns:

an instance of Lookup, which holds found controls.

See Also:

Lookup, LookupCriteria

lookup

public Lookup<CONTROL> lookup(LookupCriteria<CONTROL> criteria)

Description copied from interface: Parent

Searcher the hierarchy for objects extending T which fit the criteria.

Specified by:

lookup in interface Parent<CONTROL>

Parameters:

criteria - todo document

Returns:

an instance of Lookup, which holds found controls.

See Also:

Lookup, LookupCriteria

wait

public Lookup<? extends CONTROL> wait(int count)

Waits for certain number of controls to fit criteria. Depending on how outputs set, prints out info about the lookup.

Specified by:

wait in interface Lookup<CONTROL>

Parameters:

count - todo document

Returns:

this, after the count of found number of found controls exceeds the required.

See Also:

OUTPUT

size

public int size()

Gets the number of controls which fit criteria. Depending on how outputs set, prints out info about the lookup.

Specified by:

size in interface Lookup<CONTROL>

Returns:

todo document

See Also:

OUTPUT

check

protected boolean check(CONTROL control)

wrap

public Wrap<? extends CONTROL> wrap(int index)

Returns Wrap of the control with specified index

Specified by:

wrap in interface Lookup<CONTROL>

Parameters:

index - todo document

Returns:

Wrap

See Also:

Wrap

wrap

public Wrap<? extends CONTROL> wrap()

Description copied from interface: Lookup

Same as wrap(0)

Specified by:

wrap in interface Lookup<CONTROL>

Returns:

todo document

See Also:

Lookup.wrap(int)

as

public <INTERFACE extends ControlInterface> INTERFACE as(int index,
                                                         Class<INTERFACE> interfaceClass)

Same as wrap(index).as(interfaceClass)

Specified by:

as in interface Lookup<CONTROL>

Type Parameters:

INTERFACE - todo document

Parameters:

index - todo document

interfaceClass - todo document

Returns:

todo document

See Also:

Lookup.wrap(int), Wrap.as(java.lang.Class)

as

public <INTERFACE extends ControlInterface> INTERFACE as(Class<INTERFACE> interfaceClass)

Same as wrap().as(interfaceClass)

Specified by:

as in interface Lookup<CONTROL>

Type Parameters:

INTERFACE - todo document

Parameters:

interfaceClass - todo document

Returns:

todo document

See Also:

Lookup.wrap(), Wrap.as(java.lang.Class)

as

public <TYPE,INTERFACE extends TypeControlInterface<TYPE>> INTERFACE as(int index,
                                                                        Class<INTERFACE> interfaceClass,
                                                                        Class<TYPE> type)

Same as wrap(index).as(interfaceClass, type)

Specified by:

as in interface Lookup<CONTROL>

Type Parameters:

TYPE - todo document

INTERFACE - todo document

Parameters:

index - todo document

interfaceClass - todo document

type - todo document

Returns:

todo document

See Also:

Lookup.wrap(int), Wrap.as(java.lang.Class, java.lang.Class)

as

public <TYPE,INTERFACE extends TypeControlInterface<TYPE>> INTERFACE as(Class<INTERFACE> interfaceClass,
                                                                        Class<TYPE> type)

Same as wrap().as(interfaceClass, type)

Specified by:

as in interface Lookup<CONTROL>

Type Parameters:

TYPE - todo document

INTERFACE - todo document

Parameters:

interfaceClass - todo document

type - todo document

Returns:

todo document

See Also:

Lookup.wrap(int), Wrap.as(java.lang.Class, java.lang.Class)

get

public CONTROL get(int index)

Description copied from interface: Lookup

Returns one of the found UI controls itself.

Specified by:

get in interface Lookup<CONTROL>

Parameters:

index - todo document

Returns:

todo document

get

public CONTROL get()

Same as get(0)

Specified by:

get in interface Lookup<CONTROL>

Returns:

todo document

See Also:

Lookup.get(int)

getType

public Class<CONTROL> getType()

Specified by:

getType in interface TypeControlInterface<CONTROL>

Returns:

todo document

dumpOne

protected void dumpOne(PrintStream out,
                       CONTROL obj,
                       String prefix)

dump

protected abstract void dump(PrintStream out,
                             Lookup<? extends CONTROL> lookup)

dump

public void dump(PrintStream out)

Specified by:

dump in interface Lookup<CONTROL>