Skip to content

Fix javadocs errors and warnings #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 17, 2020
Merged

Fix javadocs errors and warnings #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/main/java/aquality/selenium/core/elements/interfaces/IElement.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public interface IElement extends IParent {

/**
* Gets current element by specified {@link #getLocator()}
* Default timeout is provided in {@link aquality.selenium.core.configurations.ITimeoutConfiguration}/>
* Default timeout is provided in {@link aquality.selenium.core.configurations.ITimeoutConfiguration}
* {@link org.openqa.selenium.NoSuchElementException} throws if element not found
*
* @return instance of {@link RemoteWebElement} if found.
Expand Down
48 changes: 33 additions & 15 deletions src/main/java/aquality/selenium/core/elements/interfaces/IElementFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ default <T extends IElement> T getCustomElement(IElementSupplier<T> elementSuppl
/**
* Create custom element according to passed parameters.
*
* @param clazz Class or interface of the element to be obtained.
* @param locator Locator of the target element.
* @param name Name of the target element.
* @param <T> Type of the target element.
* @param clazz Class or interface of the element to be obtained.
* @param locator Locator of the target element.
* @param name Name of the target element.
* @param <T> Type of the target element.
* @return Instance of custom element.
*/
default <T extends IElement> T getCustomElement(Class<T> clazz, By locator, String name) {
Expand All @@ -52,11 +52,11 @@ default <T extends IElement> T getCustomElement(Class<T> clazz, By locator, Stri
/**
* Create custom element according to passed parameters.
*
* @param clazz Class or interface of the element to be obtained.
* @param locator Locator of the target element.
* @param name Name of the target element.
* @param state Visibility state of the target element.
* @param <T> Type of the target element.
* @param clazz Class or interface of the element to be obtained.
* @param locator Locator of the target element.
* @param name Name of the target element.
* @param state Visibility state of the target element.
* @param <T> Type of the target element.
* @return Instance of custom element.
*/
<T extends IElement> T getCustomElement(Class<T> clazz, By locator, String name, ElementState state);
Expand All @@ -69,6 +69,7 @@ default <T extends IElement> T getCustomElement(Class<T> clazz, By locator, Stri
* @param name Child element name.
* @param parentElement Parent element for relative search of child element.
* @param state Visibility state of target element.
* @param <T> Type of the target element.
* @return Child element.
*/
<T extends IElement> T findChildElement(IElement parentElement, By childLoc, String name,
Expand All @@ -81,10 +82,11 @@ <T extends IElement> T findChildElement(IElement parentElement, By childLoc, Str
* @param clazz Class or interface of the element to be obtained.
* @param name Child element name.
* @param parentElement Parent element for relative search of child element.
* @param <T> Type of the target element.
* @return Child element.
*/
default <T extends IElement> T findChildElement(IElement parentElement, By childLoc, String name,
Class<T> clazz) {
Class<T> clazz) {
return findChildElement(parentElement, childLoc, name, clazz, ElementState.EXISTS_IN_ANY_STATE);
}

Expand All @@ -95,6 +97,7 @@ default <T extends IElement> T findChildElement(IElement parentElement, By child
* @param clazz Class or interface of the element to be obtained.
* @param parentElement Parent element for relative search of child element.
* @param state Visibility state of child element.
* @param <T> Type of the target element.
* @return Child element.
*/
default <T extends IElement> T findChildElement(IElement parentElement, By childLoc,
Expand All @@ -108,6 +111,7 @@ default <T extends IElement> T findChildElement(IElement parentElement, By child
* @param childLoc Locator of child element relative to its parent.
* @param clazz Class or interface of the element to be obtained.
* @param parentElement Parent element for relative search of child element.
* @param <T> Type of the target element.
* @return Child element.
*/
default <T extends IElement> T findChildElement(IElement parentElement, By childLoc,
Expand All @@ -122,10 +126,11 @@ default <T extends IElement> T findChildElement(IElement parentElement, By child
* @param supplier Required element's supplier.
* @param name Child element name.
* @param parentElement Parent element for relative search of child element.
* @param <T> Type of the target element.
* @return Child element.
*/
default <T extends IElement> T findChildElement(IElement parentElement, By childLoc, String name,
IElementSupplier<T> supplier) {
IElementSupplier<T> supplier) {
return findChildElement(parentElement, childLoc, name, supplier, ElementState.EXISTS_IN_ANY_STATE);
}

Expand All @@ -137,6 +142,7 @@ default <T extends IElement> T findChildElement(IElement parentElement, By child
* @param name Child element name.
* @param parentElement Parent element for relative search of child element.
* @param state Visibility state of child element.
* @param <T> Type of the target element.
* @return Child element.
*/
<T extends IElement> T findChildElement(IElement parentElement, By childLoc, String name,
Expand All @@ -149,10 +155,11 @@ <T extends IElement> T findChildElement(IElement parentElement, By childLoc, Str
* @param supplier Required element's supplier.
* @param parentElement Parent element for relative search of child element.
* @param state Visibility state of child element.
* @param <T> Type of the target element.
* @return Child element.
*/
default <T extends IElement> T findChildElement(IElement parentElement, By childLoc,
IElementSupplier<T> supplier, ElementState state) {
IElementSupplier<T> supplier, ElementState state) {
return findChildElement(parentElement, childLoc, null, supplier, state);
}

Expand All @@ -162,21 +169,23 @@ default <T extends IElement> T findChildElement(IElement parentElement, By child
* @param childLoc Locator of child element relative to its parent.
* @param supplier Required element's supplier.
* @param parentElement Parent element for relative search of child element.
* @param <T> Type of the target element.
* @return Child element.
*/
default <T extends IElement> T findChildElement(IElement parentElement, By childLoc,
IElementSupplier<T> supplier) {
IElementSupplier<T> supplier) {
return findChildElement(parentElement, childLoc, supplier, ElementState.EXISTS_IN_ANY_STATE);
}

/**
* Find list of elements.
*
* @param locator Elements selector.
* @param name Child element name.
* @param name Child element name.
* @param supplier Required elements' supplier.
* @param count Expected number of elements that have to be found (zero, more then zero, any).
* @param state Visibility state of target elements.
* @param <T> Type of the target element.
* @return List of elements.
*/
<T extends IElement> List<T> findElements(By locator, String name, IElementSupplier<T> supplier, ElementsCount count,
Expand All @@ -189,10 +198,11 @@ <T extends IElement> List<T> findElements(By locator, String name, IElementSuppl
* @param supplier Required elements' supplier.
* @param count Expected number of elements that have to be found (zero, more then zero, any).
* @param state Visibility state of target elements.
* @param <T> Type of the target element.
* @return List of elements.
*/
default <T extends IElement> List<T> findElements(By locator, IElementSupplier<T> supplier, ElementsCount count,
ElementState state) {
ElementState state) {
return findElements(locator, null, supplier, count, state);
}

Expand All @@ -203,6 +213,8 @@ default <T extends IElement> List<T> findElements(By locator, IElementSupplier<T
* @param name Child element name.
* @param clazz Class or interface of the element to be obtained.
* @param count Expected number of elements that have to be found (zero, more then zero, any).
* @param state Visibility state of target elements.
* @param <T> Type of the target element.
* @return List of elements.
*/
<T extends IElement> List<T> findElements(By locator, String name, Class<T> clazz, ElementsCount count, ElementState state);
Expand All @@ -213,6 +225,8 @@ default <T extends IElement> List<T> findElements(By locator, IElementSupplier<T
* @param locator Elements selector.
* @param clazz Class or interface of the element to be obtained.
* @param count Expected number of elements that have to be found (zero, more then zero, any).
* @param state Visibility state of target elements.
* @param <T> Type of the target element.
* @return List of elements.
*/
default <T extends IElement> List<T> findElements(By locator, Class<T> clazz, ElementsCount count, ElementState state) {
Expand All @@ -224,6 +238,7 @@ default <T extends IElement> List<T> findElements(By locator, Class<T> clazz, El
*
* @param locator Elements selector.
* @param clazz Class or interface of elements to be obtained.
* @param <T> Type of the target element.
* @return List of elements.
*/
default <T extends IElement> List<T> findElements(By locator, Class<T> clazz) {
Expand All @@ -237,6 +252,7 @@ default <T extends IElement> List<T> findElements(By locator, Class<T> clazz) {
* @param clazz Class or interface of elements to be obtained.
* @param name Child element name.
* @param count Expected number of elements that have to be found (zero, more then zero, any).
* @param <T> Type of the target element.
* @return List of elements.
*/
default <T extends IElement> List<T> findElements(By locator, String name, Class<T> clazz, ElementsCount count) {
Expand All @@ -249,6 +265,7 @@ default <T extends IElement> List<T> findElements(By locator, String name, Class
* @param locator Elements selector.
* @param name Child element name.
* @param clazz Class or interface of elements to be obtained.
* @param <T> Type of the target element.
* @return List of elements.
*/
default <T extends IElement> List<T> findElements(By locator, String name, Class<T> clazz) {
Expand All @@ -261,6 +278,7 @@ default <T extends IElement> List<T> findElements(By locator, String name, Class
* @param locator Elements selector.
* @param clazz Class or interface of elements to be obtained.
* @param count Expected number of elements that have to be found (zero, more then zero, any).
* @param <T> Type of the target element.
* @return List of elements.
*/
default <T extends IElement> List<T> findElements(By locator, Class<T> clazz, ElementsCount count) {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/aquality/selenium/core/elements/interfaces/IElementFinder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* - empty - to get all elements;
* - desired {@link ElementState};
* - with {@link DesiredState};
* - with {@link Predicate<WebElement>}.
* - with {@link Predicate}.
*/
public interface IElementFinder extends SearchContext {

Expand Down
1 change: 1 addition & 0 deletions src/main/java/aquality/selenium/core/logging/Logger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ public static Logger getInstance() {
* Adds appender
*
* @param appender Appender to be added
* @return logger instance
*/
public Logger addAppender(Appender appender) {
log4J.get().addAppender(appender);
Expand Down