forked from SeleniumHQ/selenium
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBy.java
More file actions
497 lines (400 loc) · 15.4 KB
/
Copy pathBy.java
File metadata and controls
497 lines (400 loc) · 15.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
package org.openqa.selenium;
import java.io.Serializable;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.BiFunction;
import java.util.stream.Stream;
import static java.util.stream.Collectors.joining;
/**
* Mechanism used to locate elements within a document. In order to create your own locating
* mechanisms, it is possible to subclass this class and override the protected methods as required,
* though it is expected that all subclasses rely on the basic finding mechanisms provided
* through static methods of this class:
*
* <code>
* public WebElement findElement(WebDriver driver) {
* WebElement element = driver.findElement(By.id(getSelector()));
* if (element == null)
* element = driver.findElement(By.name(getSelector());
* return element;
* }
* </code>
*/
public abstract class By {
/**
* @param id The value of the "id" attribute to search for.
* @return A By which locates elements by the value of the "id" attribute.
*/
public static By id(String id) {
return new ById(id);
}
/**
* @param linkText The exact text to match against.
* @return A By which locates A elements by the exact text it displays.
*/
public static By linkText(String linkText) {
return new ByLinkText(linkText);
}
/**
* @param partialLinkText The partial text to match against
* @return a By which locates elements that contain the given link text.
*/
public static By partialLinkText(String partialLinkText) {
return new ByPartialLinkText(partialLinkText);
}
/**
* @param name The value of the "name" attribute to search for.
* @return A By which locates elements by the value of the "name" attribute.
*/
public static By name(String name) {
return new ByName(name);
}
/**
* @param tagName The element's tag name.
* @return A By which locates elements by their tag name.
*/
public static By tagName(String tagName) {
return new ByTagName(tagName);
}
/**
* @param xpathExpression The XPath to use.
* @return A By which locates elements via XPath.
*/
public static By xpath(String xpathExpression) {
return new ByXPath(xpathExpression);
}
/**
* Find elements based on the value of the "class" attribute. If an element has multiple classes, then
* this will match against each of them. For example, if the value is "one two onone", then the
* class names "one" and "two" will match.
*
* @param className The value of the "class" attribute to search for.
* @return A By which locates elements by the value of the "class" attribute.
*/
public static By className(String className) {
return new ByClassName(className);
}
/**
* Find elements via the driver's underlying W3C Selector engine. If the browser does not
* implement the Selector API, a best effort is made to emulate the API. In this case, we strive
* for at least CSS2 support, but offer no guarantees.
*
* @param cssSelector CSS expression.
* @return A By which locates elements by CSS.
*/
public static By cssSelector(String cssSelector) {
return new ByCssSelector(cssSelector);
}
/**
* Find a single element. Override this method if necessary.
*
* @param context A context to use to find the element.
* @return The WebElement that matches the selector.
*/
public WebElement findElement(SearchContext context) {
List<WebElement> allElements = findElements(context);
if (allElements == null || allElements.isEmpty()) {
throw new NoSuchElementException("Cannot locate an element using " + toString());
}
return allElements.get(0);
}
/**
* Find many elements.
*
* @param context A context to use to find the elements.
* @return A list of WebElements matching the selector.
*/
public abstract List<WebElement> findElements(SearchContext context);
@Override
public boolean equals(Object o) {
if (!(o instanceof By)) {
return false;
}
By that = (By) o;
return this.toString().equals(that.toString());
}
@Override
public int hashCode() {
return toString().hashCode();
}
@Override
public String toString() {
// A stub to prevent endless recursion in hashCode()
return "[unknown locator]";
}
public abstract static class StandardLocator extends By {
@Override
public WebElement findElement(SearchContext context) {
return context.findElement(this);
}
@Override
public List<WebElement> findElements(SearchContext context) {
return context.findElements(this);
}
public abstract <T extends SearchContext> WebElement findElement(T driver, BiFunction<String, String, WebElement> finder);
public abstract <T extends SearchContext> List<WebElement> findElements(T driver, BiFunction<String, String, List<WebElement>> finder);
}
public static class ById extends StandardLocator implements Serializable {
private static final long serialVersionUID = 5341968046120372169L;
private final String id;
public ById(String id) {
if (id == null) {
throw new IllegalArgumentException("Cannot find elements when the id is null.");
}
this.id = id;
}
@Override
public <T extends SearchContext> WebElement findElement(T driver, BiFunction<String, String, WebElement> finder) {
return finder.apply("id", id);
}
@Override
public <T extends SearchContext> List<WebElement> findElements(T driver, BiFunction<String, String, List<WebElement>> finder) {
return finder.apply("id", id);
}
@Override
public String toString() {
return "By.id: " + id;
}
private Map<String, Object> toJson() {
Map<String, Object> asJson = new HashMap<>();
asJson.put("using", "css selector");
asJson.put("value", Stream.of(id.split("\\s+")).map(str -> "#" + str).collect(joining(" ")));
return Collections.unmodifiableMap(asJson);
}
}
public static class ByLinkText extends StandardLocator implements Serializable {
private static final long serialVersionUID = 1967414585359739708L;
private final String linkText;
public ByLinkText(String linkText) {
if (linkText == null) {
throw new IllegalArgumentException("Cannot find elements when the link text is null.");
}
this.linkText = linkText;
}
@Override
public <T extends SearchContext> WebElement findElement(T driver, BiFunction<String, String, WebElement> finder) {
return finder.apply("link text", linkText);
}
@Override
public <T extends SearchContext> List<WebElement> findElements(T driver, BiFunction<String, String, List<WebElement>> finder) {
return finder.apply("link text", linkText);
}
@Override
public String toString() {
return "By.linkText: " + linkText;
}
private Map<String, Object> toJson() {
Map<String, Object> asJson = new HashMap<>();
asJson.put("using", "link text");
asJson.put("value", linkText);
return Collections.unmodifiableMap(asJson);
}
}
public static class ByPartialLinkText extends StandardLocator implements Serializable {
private static final long serialVersionUID = 1163955344140679054L;
private final String partialLinkText;
public ByPartialLinkText(String partialLinkText) {
if (partialLinkText == null) {
throw new IllegalArgumentException("Cannot find elements when the link text is null.");
}
this.partialLinkText = partialLinkText;
}
@Override
public <T extends SearchContext> WebElement findElement(T driver, BiFunction<String, String, WebElement> finder) {
return finder.apply("partial link text", partialLinkText);
}
@Override
public <T extends SearchContext> List<WebElement> findElements(T driver, BiFunction<String, String, List<WebElement>> finder) {
return finder.apply("partial link text", partialLinkText);
}
@Override
public String toString() {
return "By.partialLinkText: " + partialLinkText;
}
private Map<String, Object> toJson() {
Map<String, Object> asJson = new HashMap<>();
asJson.put("using", "partial link text");
asJson.put("value", partialLinkText);
return Collections.unmodifiableMap(asJson);
}
}
public static class ByName extends StandardLocator implements Serializable {
private static final long serialVersionUID = 376317282960469555L;
private final String name;
public ByName(String name) {
if (name == null) {
throw new IllegalArgumentException("Cannot find elements when name text is null.");
}
this.name = name;
}
@Override
public <T extends SearchContext> WebElement findElement(T driver, BiFunction<String, String, WebElement> finder) {
return finder.apply("name", name);
}
@Override
public <T extends SearchContext> List<WebElement> findElements(T driver, BiFunction<String, String, List<WebElement>> finder) {
return finder.apply("name", name);
}
@Override
public String toString() {
return "By.name: " + name;
}
private Map<String, Object> toJson() {
Map<String, Object> asJson = new HashMap<>();
asJson.put("using", "css selector");
asJson.put("value", String.format("*[name='%s']", name.replace("'", "\\'")));
return Collections.unmodifiableMap(asJson);
}
}
public static class ByTagName extends StandardLocator implements Serializable {
private static final long serialVersionUID = 4699295846984948351L;
private final String tagName;
public ByTagName(String tagName) {
if (tagName == null) {
throw new IllegalArgumentException("Cannot find elements when the tag name is null.");
}
this.tagName = tagName;
}
@Override
public <T extends SearchContext> WebElement findElement(T driver, BiFunction<String, String, WebElement> finder) {
return finder.apply("tag name", tagName);
}
@Override
public <T extends SearchContext> List<WebElement> findElements(T driver, BiFunction<String, String, List<WebElement>> finder) {
return finder.apply("tag name", tagName);
}
@Override
public String toString() {
return "By.tagName: " + tagName;
}
private Map<String, Object> toJson() {
Map<String, Object> asJson = new HashMap<>();
asJson.put("using", "tag name");
asJson.put("value", tagName);
return Collections.unmodifiableMap(asJson);
}
}
public static class ByXPath extends StandardLocator implements Serializable {
private static final long serialVersionUID = -6727228887685051584L;
private final String xpathExpression;
public ByXPath(String xpathExpression) {
if (xpathExpression == null) {
throw new IllegalArgumentException(
"Cannot find elements when the XPath is null.");
}
this.xpathExpression = xpathExpression;
}
@Override
public <T extends SearchContext> WebElement findElement(T driver, BiFunction<String, String, WebElement> finder) {
return finder.apply("xpath", xpathExpression);
}
@Override
public <T extends SearchContext> List<WebElement> findElements(T driver, BiFunction<String, String, List<WebElement>> finder) {
return finder.apply("xpath", xpathExpression);
}
@Override
public String toString() {
return "By.xpath: " + xpathExpression;
}
private Map<String, Object> toJson() {
Map<String, Object> asJson = new HashMap<>();
asJson.put("using", "xpath");
asJson.put("value", xpathExpression);
return Collections.unmodifiableMap(asJson);
}
}
public static class ByClassName extends StandardLocator implements Serializable {
private static final long serialVersionUID = -8737882849130394673L;
private final String className;
public ByClassName(String className) {
if (className == null) {
throw new IllegalArgumentException(
"Cannot find elements when the class name expression is null.");
}
this.className = className;
}
@Override
public <T extends SearchContext> WebElement findElement(T driver,
BiFunction<String, String, WebElement> finder) {
return finder.apply("class name", className);
}
@Override
public <T extends SearchContext> List<WebElement> findElements(T driver,
BiFunction<String, String, List<WebElement>> finder) {
return finder.apply("class name", className);
}
/**
* Generate a partial XPath expression that matches an element whose specified attribute
* contains the given CSS word. So to match <div class='foo bar'> you would say "//div[" +
* containingWord("class", "foo") + "]".
* private Map<String, Object> toJson() {
Map<String, Object> asJson = new HashMap<>();
asJson.put("using", "link text");
asJson.put("value", linkText);
return Collections.unmodifiableMap(asJson);
}
* @param attribute name
* @param word name
* @return XPath fragment
*/
private String containingWord(String attribute, String word) {
return "contains(concat(' ',normalize-space(@" + attribute + "),' '),' " + word + " ')";
}
@Override
public String toString() {
return "By.className: " + className;
}
private Map<String, Object> toJson() {
Map<String, Object> asJson = new HashMap<>();
asJson.put("using", "css selector");
asJson.put("value", Stream.of(className.split("\\s+")).map(str -> "." + str).collect(joining(" ")));
return Collections.unmodifiableMap(asJson);
}
}
public static class ByCssSelector extends StandardLocator implements Serializable {
private static final long serialVersionUID = -3910258723099459239L;
private final String cssSelector;
public ByCssSelector(String cssSelector) {
if (cssSelector == null) {
throw new IllegalArgumentException("Cannot find elements when the selector is null");
}
this.cssSelector = cssSelector;
}
@Override
public <T extends SearchContext> WebElement findElement(T driver, BiFunction<String, String, WebElement> finder) {
return finder.apply("css selector", cssSelector);
}
@Override
public <T extends SearchContext> List<WebElement> findElements(T driver, BiFunction<String, String, List<WebElement>> finder) {
return finder.apply("css selector", cssSelector);
}
@Override
public String toString() {
return "By.cssSelector: " + cssSelector;
}
private Map<String, Object> toJson() {
Map<String, Object> asJson = new HashMap<>();
asJson.put("using", "css selector");
asJson.put("value", cssSelector);
return Collections.unmodifiableMap(asJson);
}
}
}