com.github.arachnidium.model.common.Application Maven / Gradle / Ivy
The newest version!
package com.github.arachnidium.model.common;
import org.openqa.selenium.By;
import org.openqa.selenium.WebElement;
import org.springframework.context.annotation.Configuration;
import com.github.arachnidium.core.BrowserWindow;
import com.github.arachnidium.core.Handle;
import com.github.arachnidium.core.HowToGetPage;
import com.github.arachnidium.core.HowToGetMobileScreen;
import com.github.arachnidium.core.Manager;
import com.github.arachnidium.core.MobileScreen;
import com.github.arachnidium.core.fluenthandle.IHowToGetHandle;
import com.github.arachnidium.core.settings.HandleWaitingTimeOut;
import com.github.arachnidium.model.abstractions.ModelObject;
import com.github.arachnidium.model.interfaces.IDecomposable;
import com.github.arachnidium.model.interfaces.IDecomposableByHandles;
import com.github.arachnidium.model.support.HowToGetByFrames;
/**
*
* The Common representation of any application. Using it you can model
* automated interaction with application as with a complex aggregated object.
* It is implemented as a factory by default.
*
* @param
* It means that objects can be stationed on browser window or mobile
* application screen. As for application it means the first or the
* single (main) {@link Handle} is a {@link BrowserWindow} or
* {@link MobileScreen}. And all child (decomposition) objects are on
* {@link BrowserWindow} or(/and) {@link MobileScreen}.
* If there is <S extends {@link Handle}> or
* <{@link Handle}> it means that both
* {@link BrowserWindow} and {@link MobileScreen} are possible. It is
* good for situations when interaction with UI of browser client and
* the perfectly similar mobile client has to be automated.
* If it needs to be bounded by only one {@link Handle} subclass (
* {@link BrowserWindow} or {@link MobileScreen}) then
*
* <{@link BrowserWindow}> only browser windows
* or
* <{@link MobileScreen}> only mobile screens
*
* @param
* It means the way of getting decomposable parts of the application.
* It needs to be used when it is possible the interaction with more
* than one window or mobile screen/context at the same time.
* Possible strategies are {@link HowToGetPage} and
* {@link HowToGetMobileScreen} If there is
* <S extends {@link IHowToGetHandle}> or
* <{@link IHowToGetHandle}> it means that both
* strategies are possible. It is good for situations when
* interaction with UI of browser client and the perfectly similar
* mobile client has to be automated.
*
* Also, it can be useful when it needs to bind some decomposition
* parts to concrete URLs/Android activities, page titles/context
* names etc.
*/
public abstract class Application
extends ModelObject implements IDecomposableByHandles {
/**
* @see Manager
*
* @see WindowManager
*
* @see ScreenManager
*/
protected final Manager manager;
/**
* {@link Handle} is the given browser window or mobile context which
* currently present.
* The main form or general UI of the application is stationed on this
* window or mobile context/screen
*/
@SuppressWarnings("unchecked")
protected Application(S handle) {
super(handle);
manager = (Manager) handle.nativeManager;
getWebDriverEncapsulation().addDestroyable(this);
}
private T get(Class partClass, Object[] values) {
T part = DecompositionUtil.get(partClass, values);
// get(partClass, params, values);
((FunctionalPart) part).application = this;
addChild((ModelObject) part);
return part;
}
private T getPart(Class partClass,
Handle handle, HowToGetByFrames path, By by) {
return get(partClass, new Object[] { handle, path, by });
}
/**
* Gets a representation of UI or some logically final piece of UI. It is
* general UI or its peace.
*
* @param partClass
* It is class where UI representation is described
*
* @see com.github.arachnidium.model.abstractions.ModelObject#getPart(java.lang.Class)
*
* @see IDecomposable#getPart(Class)
*/
@Override
public T getPart(Class partClass) {
return getPart(partClass, this.handle, null, null);
}
/**
* Gets a representation of UI or some logically final piece of UI. It is
* general UI or its peace which is inside frame (frame, iframe, etc). It is
* actual for browser and mobile hybrid UI.
*
* @param partClass
* It is class where representation is described
*
* @param path
* is a path to frame specified by instance of
* {@link HowToGetByFrames}
*
* @see IDecomposable#getPart(Class, HowToGetByFrames)
*
* @see ModelObject#getPart(Class, HowToGetByFrames)
*
* @see HowToGetByFrames
*/
@Override
public T getPart(Class partClass,
HowToGetByFrames path) {
return getPart(partClass, this.handle, path, null);
}
/**
* This method shuts down the application and starts the destroying of
* related information
*/
public void quit() {
getWebDriverEncapsulation().destroy();
}
/**
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
*
* If the window/context is not instantly appears the implicit time out can
* be specified in {@link Configuration}. How? See
* {@link HandleWaitingTimeOut}. Default time out is 5 seconds
*
* @param partClass
* It is class where representation is described
*
* @param handleIndex
* is an expected index of the browser window or mobile context.
*
* @see IDecomposableByHandles#getPart(Class, int)
*
* @see HandleWaitingTimeOut
*/
@Override
public T getPart(Class partClass,
int handleIndex) {
return getPart(partClass, manager.getHandle(handleIndex), null, null);
}
/**
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
* @param partClass
* It is class where representation is described
*
* @param handleIndex
* is an expected index of the browser window or mobile context
*
* @param timeOut
* is a time to wait this window/context defined explicitly. Time
* unit is seconds
*
* @see IDecomposableByHandles#getPart(Class, int, HowToGetByFrames)
*/
@Override
public T getPart(Class partClass,
int handleIndex, long timeOut) {
return getPart(partClass, manager.getHandle(handleIndex, timeOut), null, null);
}
/**
*
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
*
* This UI or fragment of UI is inside frame (frame, iframe, etc). It is
* actual for browser and mobile hybrid UI. *
*
*
* If the window/context is not instantly appears the implicit time out can
* be specified in {@link Configuration}. How? See
* {@link HandleWaitingTimeOut}. Default time out is 5 seconds
*
* @param partClass
* It is class where representation is described
*
* @param handleIndex
* is an expected index of the browser window or mobile context
*
* @param path
* is a path to desired frame specified by instance of
* {@link HowToGetByFrames}
*
* @see IDecomposableByHandles#getPart(Class, int, HowToGetByFrames)
*
* @see HowToGetByFrames
*
* @see HandleWaitingTimeOut
*/
@Override
public T getPart(Class partClass,
int handleIndex, HowToGetByFrames path) {
return getPart(partClass, manager.getHandle(handleIndex), path, null);
}
/**
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
*
* This UI or fragment of UI is inside frame (frame, iframe, etc) It is
* actual for browser and mobile hybrid UI.
*
*
* @param partClass
* It is class where representation is described
*
* @param handleIndex
* is an expected index of the browser window or mobile context
*
* @param path
* is a path to frame specified by instance of
* {@link HowToGetByFrames}
*
* @param timeOut
* is a time to wait this window/context defined explicitly. Time
* unit is seconds
*
* @see IDecomposableByHandles#getPart(Class, IHowToGetHandle,
* HowToGetByFrames, long)
*
* @see HowToGetByFrames
*/
@Override
public T getPart(Class partClass,
int handleIndex, HowToGetByFrames path, long timeOut) {
return getPart(partClass, manager.getHandle(handleIndex, timeOut), path, null);
}
/**
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
* If the window/context is not instantly appears the implicit time out can
* be specified in {@link Configuration}. How? See
* {@link HandleWaitingTimeOut}. Default time out is 5 seconds
*
* @param partClass
* It is class where representation is described
*
* @param howToGetHandle
* is a strategy of getting a new browser window/context defined
* by {@link IHowToGetHandle} implementor
*
* @see IDecomposableByHandles#getPart(Class, IHowToGetHandle)
*
* @see IHowToGetHandle
*
* @see HowToGetPage
*
* @see HowToGetMobileScreen
*
* @see HandleWaitingTimeOut
*/
@Override
public T getPart(Class partClass,
U howToGetHandle) {
return getPart(partClass, manager.getHandle(howToGetHandle), null, null);
}
/**
*
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
* @param partClass
* It is class where representation is described
*
* @param howToGetHandle
* is a strategy of getting a new browser window/context defined
* by {@link IHowToGetHandle} implementor
*
* @param timeOut
* is a time to wait this window/context defined explicitly. Time
* unit is seconds
*
* @see IDecomposableByHandles#getPart(Class, IHowToGetHandle, long)
*
* @see IHowToGetHandle
*
* @see HowToGetPage
*
* @see HowToGetMobileScreen
*/
@Override
public T getPart(Class partClass,
U howToGetHandle, long timeOut) {
return getPart(partClass, manager.getHandle(timeOut, howToGetHandle), null, null);
}
/**
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
*
* This UI or fragment of UI is inside frame (frame, iframe, etc). It is
* actual for browser and mobile hybrid UI.
*
*
*
* If the window/context is not instantly appears the implicit time out can
* be specified in {@link Configuration}. How? See
* {@link HandleWaitingTimeOut}. Default time out is 5 seconds
*
* @param partClass
* It is class where representation is described
*
* @param howToGetHandle
* is a strategy of getting a new browser window/context defined
* by {@link IHowToGetHandle} implementor
*
* @param path
* is a path to frame specified by instance of
* {@link HowToGetByFrames}
*
* @see IDecomposableByHandles#getPart(Class, IHowToGetHandle,
* HowToGetByFrames)
*
* @see IHowToGetHandle
*
* @see HowToGetPage
*
* @see HowToGetMobileScreen
*
* @see HowToGetByFrames
*
* @see HandleWaitingTimeOut
*/
@Override
public T getPart(Class partClass,
U howToGetHandle, HowToGetByFrames path) {
return getPart(partClass, manager.getHandle(howToGetHandle), path, null);
}
/**
*
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
*
* This UI or fragment of UI is inside frame (frame, iframe, etc). It is
* actual for browser and mobile hybrid UI.
*
*
*
* @param partClass
* It is class where representation is described
*
* @param howToGetHandle
* is a strategy of getting a new browser window/context defined
* by {@link IHowToGetHandle} implementor
*
* @param path
* is a path to frame specified by instance of
* {@link HowToGetByFrames}
*
* @param timeOut
* is a time to wait this window/context defined explicitly. Time
* unit is seconds
*
* @see IDecomposableByHandles#getPart(Class, IHowToGetHandle,
* HowToGetByFrames, long)
*
* @see IHowToGetHandle
*
* @see HowToGetPage
*
* @see HowToGetMobileScreen
*
* @see HowToGetByFrames
*/
@Override
public T getPart(Class partClass,
U howToGetHandle, HowToGetByFrames path, long timeOut) {
return getPart(partClass, manager.getHandle(timeOut, howToGetHandle),
path, null);
}
/**
* @return wrapped instance of {@link Manager}
*
* @see Manager
*
* @see WindowManager
*
* @see ScreenManager
*/
@SuppressWarnings("unchecked")
public > T getManager() {
return (T) manager;
}
/**
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
*
* If the window/context is not instantly appears the implicit time out can
* be specified in {@link Configuration}. How? See
* {@link HandleWaitingTimeOut}. Default time out is 5 seconds
*
* Also the root element where this UI is located is known.
*
* @param partClass
* It is class where representation is described
*
* @param handleIndex
* is an expected index of the browser window or mobile context.
*
* @param by
* Is a locator {@link By} strategy which is used to get the root
* {@link WebElement}
*
* @see IDecomposableByHandles#getPart(Class, int, by)
*
* @see HandleWaitingTimeOut
*/
@Override
public T getPart(Class partClass,
int handleIndex, By by) {
return getPart(partClass, manager.getHandle(handleIndex), null, by);
}
/**
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
* Also the root element where this UI is located is known.
*
* @param partClass
* It is class where representation is described
*
* @param handleIndex
* is an expected index of the browser window or mobile context
*
* @param by
* Is a locator {@link By} strategy which is used to get the root
* {@link WebElement}
*
* @param timeOut
* is a time to wait this window/context defined explicitly. Time
* unit is seconds
*
* @see IDecomposableByHandles#getPart(Class, int, HowToGetByFrames)
*/
@Override
public T getPart(Class partClass,
int handleIndex, By by, long timeOut) {
return getPart(partClass, manager.getHandle(handleIndex, timeOut), null, by);
}
/**
*
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
*
* This UI or fragment of UI is inside frame (frame, iframe, etc). It is
* actual for browser and mobile hybrid UI. *
*
* Also the root element where this UI is located is known.
*
* If the window/context is not instantly appears the implicit time out can
* be specified in {@link Configuration}. How? See
* {@link HandleWaitingTimeOut}. Default time out is 5 seconds
*
* @param partClass
* It is class where representation is described
*
* @param handleIndex
* is an expected index of the browser window or mobile context
*
* @param path
* is a path to desired frame specified by instance of
* {@link HowToGetByFrames}
*
* @param by
* Is a locator {@link By} strategy which is used to get the root
* {@link WebElement}
*
* @see IDecomposableByHandles#getPart(Class, int, HowToGetByFrames)
*
* @see HowToGetByFrames
*
* @see HandleWaitingTimeOut
*/
@Override
public T getPart(Class partClass,
int handleIndex, HowToGetByFrames path, By by) {
return getPart(partClass, manager.getHandle(handleIndex), path, by);
}
/**
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
*
* This UI or fragment of UI is inside frame (frame, iframe, etc) It is
* actual for browser and mobile hybrid UI.
*
* Also the root element where this UI is located is known.
*
* @param partClass
* It is class where representation is described
*
* @param handleIndex
* is an expected index of the browser window or mobile context
*
* @param path
* is a path to frame specified by instance of
* {@link HowToGetByFrames}
*
* @param by
* Is a locator {@link By} strategy which is used to get the root
* {@link WebElement}
*
* @param timeOut
* is a time to wait this window/context defined explicitly. Time
* unit is seconds
*
* @see IDecomposableByHandles#getPart(Class, IHowToGetHandle,
* HowToGetByFrames, long)
*
* @see HowToGetByFrames
*/
@Override
public T getPart(Class partClass,
int handleIndex, HowToGetByFrames path, By by, long timeOut) {
return getPart(partClass, manager.getHandle(handleIndex, timeOut),
path, by);
}
/**
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
*
* If the window/context is not instantly appears the implicit time out can
* be specified in {@link Configuration}. How? See
* {@link HandleWaitingTimeOut}. Default time out is 5 seconds
*
* Also the root element where this UI is located is known.
*
* @param partClass
* It is class where representation is described
*
* @param howToGetHandle
* is a strategy of getting a new browser window/context defined
* by {@link IHowToGetHandle} implementor
*
* @param by
* Is a locator {@link By} strategy which is used to get the root
* {@link WebElement}
*
* @see IDecomposableByHandles#getPart(Class, IHowToGetHandle)
*
* @see IHowToGetHandle
*
* @see HowToGetPage
*
* @see HowToGetMobileScreen
*
* @see HandleWaitingTimeOut
*/
@Override
public T getPart(Class partClass,
U howToGetHandle, By by) {
return getPart(partClass, manager.getHandle(howToGetHandle), null, by);
}
/**
*
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
* Also the root element where this UI is located is known.
*
* @param partClass
* It is class where representation is described
*
* @param howToGetHandle
* is a strategy of getting a new browser window/context defined
* by {@link IHowToGetHandle} implementor
*
* @param by
* Is a locator {@link By} strategy which is used to get the root
* {@link WebElement}
*
* @param timeOut
* is a time to wait this window/context defined explicitly. Time
* unit is seconds
*
* @see IDecomposableByHandles#getPart(Class, IHowToGetHandle, long)
*
* @see IHowToGetHandle
*
* @see HowToGetPage
*
* @see HowToGetMobileScreen
*/
@Override
public T getPart(Class partClass,
U howToGetHandle, By by, long timeOut) {
return getPart(partClass, manager.getHandle(timeOut, howToGetHandle),
null, by);
}
/**
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
*
* This UI or fragment of UI is inside frame (frame, iframe, etc). It is
* actual for browser and mobile hybrid UI.
*
* Also the root element where this UI is located is known.
*
*
*
* If the window/context is not instantly appears the implicit time out can
* be specified in {@link Configuration}. How? See
* {@link HandleWaitingTimeOut}. Default time out is 5 seconds
*
* @param partClass
* It is class where representation is described
*
* @param howToGetHandle
* is a strategy of getting a new browser window/context defined
* by {@link IHowToGetHandle} implementor
*
* @param path
* is a path to frame specified by instance of
* {@link HowToGetByFrames}
*
* @param by
* Is a locator {@link By} strategy which is used to get the root
* {@link WebElement}
*
* @see IDecomposableByHandles#getPart(Class, IHowToGetHandle,
* HowToGetByFrames)
*
* @see IHowToGetHandle
*
* @see HowToGetPage
*
* @see HowToGetMobileScreen
*
* @see HowToGetByFrames
*
* @see HandleWaitingTimeOut
*/
@Override
public T getPart(Class partClass,
U howToGetHandle, HowToGetByFrames path, By by) {
return getPart(partClass, manager.getHandle(howToGetHandle), path, by);
}
/**
*
* Gets a representation of UI or some logically final piece of UI. This
* method is used when where are more than one browser window or mobile
* contexts exist (NATIVE_APP, WEBVIEW_0, WEBVIEW_1 and so on) at one time.
*
*
* This UI or fragment of UI is inside frame (frame, iframe, etc). It is
* actual for browser and mobile hybrid UI.
*
* Also the root element where this UI is located is known.
*
* @param partClass
* It is class where representation is described
*
* @param howToGetHandle
* is a strategy of getting a new browser window/context defined
* by {@link IHowToGetHandle} implementor
*
* @param path
* is a path to frame specified by instance of
* {@link HowToGetByFrames}
*
* @param by
* Is a locator {@link By} strategy which is used to get the root
* {@link WebElement}
*
* @param timeOut
* is a time to wait this window/context defined explicitly. Time
* unit is seconds
*
* @see IDecomposableByHandles#getPart(Class, IHowToGetHandle,
* HowToGetByFrames, long)
*
* @see IHowToGetHandle
*
* @see HowToGetPage
*
* @see HowToGetMobileScreen
*
* @see HowToGetByFrames
*/
@Override
public T getPart(Class partClass,
U howToGetHandle, HowToGetByFrames path, By by, long timeOut) {
return getPart(partClass, manager.getHandle(timeOut, howToGetHandle),
path, by);
}
/**
* Gets a representation of UI or some logically final piece of UI. It is
* general UI or its peace.
*
* The root element where this UI is located is known.
*
* @param partClass
* It is class where UI representation is described
* @param by
* Is a locator {@link By} strategy which is used to get the root
* {@link WebElement}
*
* @see com.github.arachnidium.model.abstractions.ModelObject#getPart(java.lang.Class)
*
* @see IDecomposable#getPart(Class)
*/
@Override
public T getPart(Class partClass, By by) {
return getPart(partClass, this.handle, null, by);
}
/**
* Gets a representation of UI or some logically final piece of UI. It is
* general UI or its peace which is inside frame (frame, iframe, etc). It is
* actual for browser and mobile hybrid UI.
*
* The root element where this UI is located is known.
*
* @param partClass
* It is class where representation is described
*
* @param path
* is a path to frame specified by instance of
* {@link HowToGetByFrames}
*
* @param by
* Is a locator {@link By} strategy which is used to get the root
* {@link WebElement}
*
* @see IDecomposable#getPart(Class, HowToGetByFrames)
*
* @see ModelObject#getPart(Class, HowToGetByFrames)
*
* @see HowToGetByFrames
*/
@Override
public T getPart(Class partClass,
HowToGetByFrames path, By by) {
return getPart(partClass, this.handle, path, by);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy