hu.ibello.search

Enum By

java.lang.Object

java.lang.Enum<By>

hu.ibello.search.By

All Implemented Interfaces:

Serializable, Comparable<By>

public enum By
extends Enum<By>

This enum symbolizes an element search algorithm. During element search on web-pages, a search algorithm and a search pattern is used to find the desired elements. The meaning of the pattern is specified by the search algorithm (an enum constant).

About ibello search engine see hu.ibello.search.

Author:

Kornél Simon

Enum Constant Summary

Enum Constants

Enum Constant and Description
BUTTON_CLASS Search by the CSS class of a button.
BUTTON_TEXT Search by text of a button.
CLASS_NAME Search by CSS class name.
CSS_SELECTOR Search by CSS selector.
ID Search by ID.
LABEL Search by label.
NAME Search by name.
PARTIAL_BUTTON_TEXT Search by partial text of a button.
PARTIAL_LABEL Search by partial label.
PARTIAL_TEXT Search by the partial text of an element.
TAG_NAME Search by tag name.
TEXT Search by the text of an element.

Method Summary

Modifier and Type	Method and Description
static By	valueOf(String name) Returns the enum constant of this type with the specified name.
static By[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CSS_SELECTOR

public static final By CSS_SELECTOR

Search by CSS selector. The search pattern can be any valid CSS selector.

ID

public static final By ID

Search by ID. The search pattern is an ID of an element.

NAME

public static final By NAME

Search by name. The search pattern if the value of the name attribute of the desired element(s).

TAG_NAME

public static final By TAG_NAME

Search by tag name. The search pattern is the tag name of the desired element(s).

CLASS_NAME

public static final By CLASS_NAME

Search by CSS class name. The search pattern is a CSS cass name which is assigned to the desired element(s).

BUTTON_TEXT

public static final By BUTTON_TEXT

Search by text of a button. The search pattern is the case-sensitive text of the desired element. The element itself can be:

• a button with the given text,
• an input field for which the value attribute is the given text, and the type attribute is button, submit or reset,
• an input field for which the alt attribute is the given text, and the type attribute is image
• an a (link) element with the given text,
• an element with role=button attribute.

During the search, the first two categories are preferred. It means that if the search results a positive outcome for the first category, then the other categories are not searched.

TEXT

public static final By TEXT

Search by the text of an element. The search pattern is the case-sensitive content of the desired element.

LABEL

public static final By LABEL

Search by label. The search pattern is the case-sensitive content of a label element. The label should belong to the desired element. It means that:

• The label has a for attribute, and the value of this attribute matches the id attribute of the desired element.
• The label does not have for attribute, but there is a single input, textarea or select element inside of it's parent or it's grandparent - that single element will be the desired one.

PARTIAL_BUTTON_TEXT

public static final By PARTIAL_BUTTON_TEXT

Search by partial text of a button. The search pattern is part of the desired element's text, case-sensitively. The element itself can be:

• a button with the given text,
• an input field for which the value attribute is the given text, and the type attribute is button, submit or reset,
• an input field for which the alt attribute is the given text, and the type attribute is image
• an a (link) element with the given text,
• an element with role=button attribute.

During the search, the first two categories are preferred. It means that if the search results a positive outcome for the first category, then the other categories are not searched.

PARTIAL_TEXT

public static final By PARTIAL_TEXT

Search by the partial text of an element. The search pattern is part of the desired element's text, case-sensitively.

PARTIAL_LABEL

public static final By PARTIAL_LABEL

Search by partial label. The search pattern is the part of a label element's content. The label should belong to the desired element. It means that:

• The label has a for attribute, and the value of this attribute matches the id attribute of the desired element.
• The label does not have for attribute, but there is a single input, textarea or select element inside of it's parent or it's grandparent - that single element will be the desired one.

BUTTON_CLASS

public static final By BUTTON_CLASS

Search by the CSS class of a button. The search pattern is a CSS class name. The class may belong to the button itself or to one of it's descendants. The element itself can be:

• a button,
• an input field for which the type attribute is button, submit, reset or image,
• an a (link) element,
• an element with role=button attribute.

Method Detail

values

public static By[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (By c : By.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static By valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null