-
Notifications
You must be signed in to change notification settings - Fork 9
/
Operator.java
1630 lines (1476 loc) · 49.6 KB
/
Operator.java
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
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 1997, 2020, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package org.netbeans.jemmy.operators;
import java.awt.Component;
import java.awt.event.InputEvent;
import java.lang.reflect.InvocationTargetException;
import java.util.Hashtable;
import java.util.StringTokenizer;
import java.util.Vector;
import org.netbeans.jemmy.Action;
import org.netbeans.jemmy.ActionProducer;
import org.netbeans.jemmy.CharBindingMap;
import org.netbeans.jemmy.ClassReference;
import org.netbeans.jemmy.ComponentChooser;
import org.netbeans.jemmy.ComponentSearcher;
import org.netbeans.jemmy.JemmyException;
import org.netbeans.jemmy.JemmyProperties;
import org.netbeans.jemmy.Outputable;
import org.netbeans.jemmy.QueueTool;
import org.netbeans.jemmy.TestOut;
import org.netbeans.jemmy.TimeoutExpiredException;
import org.netbeans.jemmy.Timeoutable;
import org.netbeans.jemmy.Timeouts;
import org.netbeans.jemmy.Waitable;
import org.netbeans.jemmy.Waiter;
import org.netbeans.jemmy.util.DefaultVisualizer;
import org.netbeans.jemmy.util.MouseVisualizer;
import org.netbeans.jemmy.util.Platform;
/**
* Keeps all environment and low-level methods.
*
* @author Alexandre Iline (alexandre.iline@oracle.com)
*/
public abstract class Operator
implements Timeoutable, Outputable {
/**
* Identifier for a "class" property.
*
* @see #getDump
*/
public static final String CLASS_DPROP = "Class";
/**
* Identifier for a "toString" property.
*
* @see #getDump
*/
public static final String TO_STRING_DPROP = "toString";
private static Vector<String> operatorPkgs;
private Timeouts timeouts;
private TestOut output;
private CharBindingMap map;
private ComponentVisualizer visualizer;
private StringComparator comparator;
private PathParser parser;
private QueueTool queueTool;
private boolean verification = false;
private JemmyProperties properties;
/**
* Inits environment.
*/
public Operator() {
super();
initEnvironment();
}
/**
* Specifies an object to be used by default to prepare component. Each new
* operator created after the method using will have defined visualizer.
* Default implementation is org.netbeans.jemmy.util.DefaultVisualizer
* class.
*
* @param visualizer ComponentVisualizer implementation
* @return previous value
* @see #setVisualizer(Operator.ComponentVisualizer)
* @see #getDefaultComponentVisualizer()
* @see org.netbeans.jemmy.util.DefaultVisualizer
*/
public static ComponentVisualizer setDefaultComponentVisualizer(ComponentVisualizer visualizer) {
return ((ComponentVisualizer) JemmyProperties.
setCurrentProperty("ComponentOperator.ComponentVisualizer", visualizer));
}
/**
* Returns an object to be used by default to prepare component.
*
* @return Object is used by default to prepare component
* @see #getVisualizer()
* @see #setDefaultComponentVisualizer(Operator.ComponentVisualizer)
*/
public static ComponentVisualizer getDefaultComponentVisualizer() {
return ((ComponentVisualizer) JemmyProperties.
getCurrentProperty("ComponentOperator.ComponentVisualizer"));
}
/**
* Defines string comparator to be assigned in constructor.
*
* @param comparator the comparator to be used by default.
* @return previous value.
* @see #getDefaultStringComparator()
* @see Operator.StringComparator
*/
public static StringComparator setDefaultStringComparator(StringComparator comparator) {
return ((StringComparator) JemmyProperties.
setCurrentProperty("ComponentOperator.StringComparator", comparator));
}
/**
* Returns string comparator used to init operators.
*
* @return the comparator used by default.
* @see #setDefaultStringComparator(Operator.StringComparator)
* @see Operator.StringComparator
*/
public static StringComparator getDefaultStringComparator() {
return ((StringComparator) JemmyProperties.
getCurrentProperty("ComponentOperator.StringComparator"));
}
/**
* Specifies an object used for parsing of path-like strings.
*
* @param parser the parser.
* @return a previous value.
* @see Operator.PathParser
* @see #getDefaultPathParser
*/
public static PathParser setDefaultPathParser(PathParser parser) {
return ((PathParser) JemmyProperties.
setCurrentProperty("ComponentOperator.PathParser", parser));
}
/**
* Returns an object used for parsing of path-like strings.
*
* @return a parser used by default.
* @see Operator.PathParser
* @see #setDefaultPathParser
*/
public static PathParser getDefaultPathParser() {
return ((PathParser) JemmyProperties.
getCurrentProperty("ComponentOperator.PathParser"));
}
/**
* Defines whether newly created operators should perform operation
* verifications by default.
*
* @param verification a verification mode to be used by default.
* @return a previous value.
* @see #getDefaultVerification()
* @see #setVerification(boolean)
*/
public static boolean setDefaultVerification(boolean verification) {
Boolean oldValue = (Boolean) (JemmyProperties.
setCurrentProperty("Operator.Verification",
verification ? Boolean.TRUE : Boolean.FALSE));
return (oldValue != null) ? oldValue : false;
}
/**
* Says whether newly created operators perform operations verifications by
* default.
*
* @return a verification mode used by default.
* @see #setDefaultVerification(boolean)
* @see #getVerification()
*/
public static boolean getDefaultVerification() {
return ((Boolean) (JemmyProperties.
getCurrentProperty("Operator.Verification")));
}
/**
* Compares caption (button text, window title, ...) with a sample text.
*
* @param caption String to be compared with match. Method returns false, if
* parameter is null.
* @param match Sample to compare with. Method returns true, if parameter is
* null.
* @param ce Compare exactly. If true, text can be a substring of caption.
* @param ccs Compare case sensitively. If true, both text and caption are
* converted to upper case before comparison.
* @return true is the captions matched the match.
* @see #isCaptionEqual
* @deprecated use another methods with the same name.
*/
@Deprecated
public static boolean isCaptionEqual(String caption, String match, boolean ce, boolean ccs) {
return new DefaultStringComparator(ce, ccs).equals(caption, match);
}
/**
* Compares caption (button text, window title, ...) with a sample text.
*
* @param caption String to be compared with match
* @param match Sample to compare with
* @param comparator StringComparator instance.
* @return true is the captions matched the match.
* @see #isCaptionEqual
*/
public static boolean isCaptionEqual(String caption, String match, StringComparator comparator) {
return comparator.equals(caption, match);
}
/**
* Returns default mouse button mask.
*
* @return {@code InputEvent.BUTTON*_MASK} field value
*/
public static int getDefaultMouseButton() {
return InputEvent.BUTTON1_MASK;
}
/**
* Returns mask of mouse button which used to popup expanding.
* (InputEvent.BUTTON3_MASK)
*
* @return {@code InputEvent.BUTTON*_MASK} field value
*/
public static int getPopupMouseButton() {
return InputEvent.BUTTON3_MASK;
}
/**
* Creates operator for component. Tries to find class with "operator
* package"."class name"Operator name, where "operator package" is a package
* from operator packages list, and "class name" is the name of class or one
* of its superclasses.
*
* @param comp Component to create operator for.
* @return a new operator with default environment.
* @see #addOperatorPackage(String)
*/
public static ComponentOperator createOperator(Component comp) {
//hack!
try {
Class<?> cclass = Class.forName("java.awt.Component");
Class<?> compClass = comp.getClass();
ComponentOperator result;
do {
if ((result = createOperator(comp, compClass)) != null) {
return result;
}
} while (cclass.isAssignableFrom(compClass = compClass.getSuperclass()));
} catch (ClassNotFoundException ignored) {
}
return null;
}
/**
* Adds package to the list of packages containing operators. <BR>
* "org.netbeans.jemmy.operators" is in the list by default.
*
* @param pkgName Package name.
* @see #createOperator(Component)
*/
public static void addOperatorPackage(String pkgName) {
operatorPkgs.add(pkgName);
}
/**
* Returns an operator containing default environment.
*
* @return an empty operator (not having any component source) having
* default environment.
*/
public static Operator getEnvironmentOperator() {
return new NullOperator();
}
static {
//init visualizer depending on OS:
//Linux - new MouseVisualizer(MouseVisualizer.TOP, 0.5, 10, false)
//solaris - new MouseVisualizer()
//others - new DefaultVisualizer()
if (Platform.isLinux()) {
setDefaultComponentVisualizer(new MouseVisualizer(MouseVisualizer.TOP, 0.5, 10, false));
} else if (Platform.isSolaris()) {
setDefaultComponentVisualizer(new MouseVisualizer());
} else {
setDefaultComponentVisualizer(new DefaultVisualizer());
}
operatorPkgs = new Vector<>();
setDefaultStringComparator(new DefaultStringComparator(false, false));
setDefaultPathParser(new DefaultPathParser("|"));
addOperatorPackage("org.netbeans.jemmy.operators");
setDefaultVerification(true);
}
/**
* Returns object operator is used for.
*
* @return an instance of java.awt.Component subclass which this operator
* was created for.
*/
public abstract Component getSource();
////////////////////////////////////////////////////////
//Environment //
////////////////////////////////////////////////////////
/**
* Returns QueueTool is used to work with queue.
*
* @return a QueueTool.
*/
public QueueTool getQueueTool() {
return queueTool;
}
/**
* Copies all environment (output, timeouts, visualizer) from another
* operator.
*
* @param anotherOperator an operator to copy the environment to.
*/
public void copyEnvironment(Operator anotherOperator) {
setTimeouts(anotherOperator.getTimeouts());
setOutput(anotherOperator.getOutput());
setVisualizer(anotherOperator.getVisualizer());
setComparator(anotherOperator.getComparator());
setVerification(anotherOperator.getVerification());
setCharBindingMap(anotherOperator.getCharBindingMap());
setProperties(anotherOperator.getProperties());
}
@Override
public void setTimeouts(Timeouts timeouts) {
this.timeouts = timeouts;
queueTool.setTimeouts(timeouts);
}
@Override
public Timeouts getTimeouts() {
return timeouts;
}
/**
* Returns component visualizer. Visualizer is used from from
* makeComponentVisible() method.
*
* @return a visualizer assigned to this operator.
* @see #getDefaultComponentVisualizer()
* @see #setVisualizer(Operator.ComponentVisualizer)
*/
public ComponentVisualizer getVisualizer() {
return visualizer;
}
/**
* Changes component visualizer. Visualizer is used from from
* makeComponentVisible() method.
*
* @param vo a visualizer to assign to this operator.
* @see #setDefaultComponentVisualizer(Operator.ComponentVisualizer)
* @see #getVisualizer()
*/
public void setVisualizer(ComponentVisualizer vo) {
visualizer = vo;
}
/**
* Returns a JemmyProperty object assigned to this operator.
*
* @return a JemmyProperty object got from the top of property stack or from
* another operator by copyuing environment.
* @see #setProperties
*/
public JemmyProperties getProperties() {
return properties;
}
/**
* Assigns a JemmyProperty object to this operator.
*
* @param properties a properties to assign to this operator.
* @return previously assigned properties.
* @see #getProperties
*/
public JemmyProperties setProperties(JemmyProperties properties) {
JemmyProperties oldProperties = getProperties();
this.properties = properties;
return oldProperties;
}
/**
* Defines CharBindingMap.
*
* @param map a CharBindingMap to use for keyboard operations.
* @see org.netbeans.jemmy.CharBindingMap
* @see
* org.netbeans.jemmy.JemmyProperties#setCurrentCharBindingMap(CharBindingMap)
* @see #getCharBindingMap
*/
public void setCharBindingMap(CharBindingMap map) {
this.map = map;
}
/**
* Returns CharBindingMap used for keyboard operations.
*
* @return a map assigned to this object.
* @see #setCharBindingMap
*/
public CharBindingMap getCharBindingMap() {
return map;
}
@Override
public void setOutput(TestOut out) {
output = out;
queueTool.setOutput(output.createErrorOutput());
}
@Override
public TestOut getOutput() {
return output;
}
/**
* Returns object which is used for string comparison.
*
* @return a comparator assigned to this operator.
* @see org.netbeans.jemmy.operators.Operator.StringComparator
* @see org.netbeans.jemmy.operators.Operator.DefaultStringComparator
* @see #setComparator
*/
public StringComparator getComparator() {
return comparator;
}
/**
* Defines object which is used for string comparison.
*
* @param comparator a comparator to use for string comparision.
* @see org.netbeans.jemmy.operators.Operator.StringComparator
* @see org.netbeans.jemmy.operators.Operator.DefaultStringComparator
* @see #getComparator
*/
public void setComparator(StringComparator comparator) {
this.comparator = comparator;
}
/**
* Returns object which is used for parsing of path-like strings.
*
* @return a comparator assigned to this operator.
* @see #setPathParser
*/
public PathParser getPathParser() {
return parser;
}
/**
* Specifies object which is used for parsing of path-like strings.
*
* @param parser a parser to use for path parsing.
* @see #getPathParser
*/
public void setPathParser(PathParser parser) {
this.parser = parser;
}
/**
* Defines whether operator should perform operation verifications.
*
* @param verification new value.
* @return old value
* @see #setDefaultVerification(boolean)
* @see #getDefaultVerification()
* @see #getVerification()
*/
public boolean setVerification(boolean verification) {
boolean oldValue = this.verification;
this.verification = verification;
return oldValue;
}
/**
* Says whether operator performs operation verifications.
*
* @return old value
* @see #setDefaultVerification(boolean)
* @see #getDefaultVerification()
* @see #setVerification(boolean)
*/
public boolean getVerification() {
return verification;
}
////////////////////////////////////////////////////////
//Util //
////////////////////////////////////////////////////////
/**
* Creates new array which has all elements from first array, except last
* element.
*
* @param path an original array
* @return new array
*/
public String[] getParentPath(String path[]) {
if (path.length > 1) {
String[] ppath = new String[path.length - 1];
System.arraycopy(path, 0, ppath, 0, ppath.length);
return ppath;
} else {
return new String[0];
}
}
public ComponentChooser[] getParentPath(ComponentChooser path[]) {
if (path.length > 1) {
ComponentChooser[] ppath = new ComponentChooser[path.length - 1];
System.arraycopy(path, 0, ppath, 0, ppath.length);
return ppath;
} else {
return new ComponentChooser[0];
}
}
/**
* Parses a string to a string array using a PathParser assigned to this
* operator.
*
* @param path an original string
* @return created String array.
*/
public String[] parseString(String path) {
return getPathParser().parse(path);
}
/**
* Parses strings like "1|2|3" into arrays {"1", "2", "3"}.
*
* @param path an original string
* @param delim a delimiter string
* @return created String array.
*/
public String[] parseString(String path, String delim) {
return new DefaultPathParser(delim).parse(path);
}
/**
* Returns key code to be pressed for character typing.
*
* @param c Character to be typed.
* @return a value of one of the {@code KeyEvent.VK_*} fields.
* @see org.netbeans.jemmy.CharBindingMap
*/
public int getCharKey(char c) {
return map.getCharKey(c);
}
/**
* Returns modifiers mask for character typing.
*
* @param c Character to be typed.
* @return a combination of {@code InputEvent.*_MASK} fields.
* @see org.netbeans.jemmy.CharBindingMap
*/
public int getCharModifiers(char c) {
return map.getCharModifiers(c);
}
/**
* Returns key codes to by pressed for characters typing.
*
* @param c Characters to be typed.
* @return an array of {@code KeyEvent.VK_*} values.
* @see org.netbeans.jemmy.CharBindingMap
*/
public int[] getCharsKeys(char[] c) {
int[] result = new int[c.length];
for (int i = 0; i < c.length; i++) {
result[i] = getCharKey(c[i]);
}
return result;
}
/**
* Returns modifiers masks for characters typing.
*
* @param c Characters to be typed.
* @return an array of a combination of {@code InputEvent.*_MASK}
* fields.
* @see org.netbeans.jemmy.CharBindingMap
*/
public int[] getCharsModifiers(char[] c) {
int[] result = new int[c.length];
for (int i = 0; i < c.length; i++) {
result[i] = getCharModifiers(c[i]);
}
return result;
}
/**
* Returns key codes to by pressed for the string typing.
*
* @param s String to be typed.
* @return an array of {@code KeyEvent.VK_*} values.
* @see org.netbeans.jemmy.CharBindingMap
*/
public int[] getCharsKeys(String s) {
return getCharsKeys(s.toCharArray());
}
/**
* Returns modifiers masks for the string typing.
*
* @param s String to be typed.
* @return an array of a combination of {@code InputEvent.*_MASK}
* fields.
* @see org.netbeans.jemmy.CharBindingMap
*/
public int[] getCharsModifiers(String s) {
return getCharsModifiers(s.toCharArray());
}
/**
* Compares string using getComparator StringComparator.
*
* @param caption a caption
* @param match a pattern
* @return true if {@code caption} and {@code match} match
* @see #isCaptionEqual
*/
public boolean isCaptionEqual(String caption, String match) {
return comparator.equals(caption, match);
}
/**
* Prints component information into operator output.
*/
public void printDump() {
Hashtable<String, Object> result = getDump();
Object[] keys = result.keySet().toArray();
for (int i = 0; i < result.size(); i++) {
output.printLine(keys[i]
+ " = "
+ result.get(keys[i]));
}
}
/**
* Returns information about component. All records marked by simbolic
* constants defined in public static final {@code *_DPROP} fields for
* each operator type.
*
* @return a Hashtable containing name-value pairs.
*/
public Hashtable<String, Object> getDump() {
Hashtable<String, Object> result = new Hashtable<>();
result.put(CLASS_DPROP, getSource().getClass().getName());
result.put(TO_STRING_DPROP, getSource().toString());
return result;
}
/**
* Waits a state specified by a ComponentChooser instance.
*
* @param state a ComponentChooser defining the state criteria.
* @throws TimeoutExpiredException if the state has not achieved in a value
* defined by {@code "ComponentOperator.WaitStateTimeout"}
*/
public void waitState(final ComponentChooser state) {
waitState(new Waitable<String, Void>() {
@Override
public String actionProduced(Void obj) {
return state.checkComponent(getSource()) ? "" : null;
}
@Override
public String getDescription() {
return "Wait \"" + state.getDescription()
+ "\" state to be reached";
}
@Override
public String toString() {
return "Operator.waitState.Waitable{description = " + getDescription() + '}';
}
});
}
public <R> R waitState(Waitable<R, Void> waitable) {
Waiter<R, Void> stateWaiter = new Waiter<>(waitable);
stateWaiter.setTimeoutsToCloneOf(getTimeouts(),
"ComponentOperator.WaitStateTimeout");
stateWaiter.setOutput(getOutput().createErrorOutput());
try {
return stateWaiter.waitAction(null);
} catch (InterruptedException e) {
throw new JemmyException(
"Waiting of \"" + waitable.getDescription()
+ "\" state has been interrupted!");
}
}
/**
* Waits a state specified by a ComponentChooser instance on EDT queue.
*
* @param state a ComponentChooser defining the state criteria.
* @throws TimeoutExpiredException if the state has not achieved in a value
* defined by {@code "ComponentOperator.WaitStateTimeout"}
*/
public void waitStateOnQueue(final ComponentChooser state) {
waitState(new ComponentChooser() {
@Override
public boolean checkComponent(Component comp) {
return (boolean) (queueTool.invokeSmoothly(
new QueueTool.QueueAction<Object>("checkComponent") {
@Override
public final Object launch() throws Exception {
return state.checkComponent(comp);
}
}));
}
@Override
public String getDescription() {
return state.getDescription();
}
});
}
////////////////////////////////////////////////////////
//Mapping //
////////////////////////////////////////////////////////
/**
* Performs an operation with time control.
*
* @param action an action to execute.
* @param param an action parameters.
* @param actionTimeOrigin is a timeout name to use for waiting for the
* action to be finished.
* @return an action result.
*/
protected <R, P> R produceTimeRestricted(Action<R, P> action, final P param,
String actionTimeOrigin) {
ActionProducer<R, P> producer = new ActionProducer<>(action);
producer.setOutput(getOutput().createErrorOutput());
producer.setTimeouts(getTimeouts().cloneThis());
producer.getTimeouts().setTimeout("ActionProducer.MaxActionTime",
getTimeouts().getTimeout(actionTimeOrigin));
try {
R result = producer.produceAction(param, actionTimeOrigin);
Throwable exception = producer.getException();
if (exception != null) {
if (exception instanceof JemmyException) {
throw ((JemmyException) exception);
} else {
throw (new JemmyException("Exception during " + action.getDescription(),
exception));
}
}
return result;
} catch (InterruptedException e) {
throw (new JemmyException("Interrupted!", e));
}
}
/**
* Performs an operation with time control.
*
* @param action an action to execute.
* @param actionTimeOrigin is a timeout name to use for waiting for the
* action to be finished.
* @return an action result.
*/
protected <R, P> R produceTimeRestricted(Action<R, P> action, String actionTimeOrigin) {
return produceTimeRestricted(action, null, actionTimeOrigin);
}
/**
* Performs an operation without time control.
*
* @param action an action to execute.
* @param param an action parameters.
*/
protected <R, P> void produceNoBlocking(NoBlockingAction<R, P> action, P param) {
try {
ActionProducer<R, P> noBlockingProducer = new ActionProducer<>(action, false);
noBlockingProducer.setOutput(output.createErrorOutput());
noBlockingProducer.setTimeouts(timeouts);
noBlockingProducer.produceAction(param, null);
} catch (InterruptedException e) {
throw (new JemmyException("Exception during \""
+ action.getDescription()
+ "\" execution",
e));
}
if (action.exception != null) {
throw (new JemmyException("Exception during nonblocking \""
+ action.getDescription() + "\"",
action.exception));
}
}
/**
* Performs an operation without time control.
*
* @param action an action to execute.
*/
protected void produceNoBlocking(NoBlockingAction<?, ?> action) {
produceNoBlocking(action, null);
}
/**
* Equivalent to {@code getQueue().lock();}.
*/
protected void lockQueue() {
queueTool.lock();
}
/**
* Equivalent to {@code getQueue().unlock();}.
*/
protected void unlockQueue() {
queueTool.unlock();
}
/**
* Unlocks Queue and then throw exception.
*
* @param e an exception to be thrown.
*/
protected void unlockAndThrow(Exception e) {
unlockQueue();
throw (new JemmyException("Exception during queue locking", e));
}
/**
* To map nonprimitive type component's method.
*
* @param action a mapping action.
* @return an action result.
* @see Operator.MapAction
*/
protected <R> R runMapping(MapAction<R> action) {
return runMappingPrimitive(action);
}
/**
* To map char component's method.
*
* @param action a mapping action.
* @return an action result.
* @see #runMapping(Operator.MapAction)
* @see Operator.MapCharacterAction
*/
protected char runMapping(MapCharacterAction action) {
return (Character) runMappingPrimitive(action);
}
/**
* To map byte component's method.
*
* @param action a mapping action.
* @return an action result.
* @see #runMapping(Operator.MapAction)
* @see Operator.MapByteAction
*/
protected byte runMapping(MapByteAction action) {
return (Byte) runMappingPrimitive(action);
}
/**
* To map int component's method.
*
* @param action a mapping action.
* @return an action result.
* @see #runMapping(Operator.MapAction)
* @see Operator.MapIntegerAction
*/
protected int runMapping(MapIntegerAction action) {
return (Integer) runMappingPrimitive(action);
}
/**
* To map long component's method.
*
* @param action a mapping action.
* @return an action result.
* @see #runMapping(Operator.MapAction)
* @see Operator.MapLongAction
*/
protected long runMapping(MapLongAction action) {
return (Long) runMappingPrimitive(action);
}
/**
* To map float component's method.
*
* @param action a mapping action.
* @return an action result.
* @see #runMapping(Operator.MapAction)
* @see Operator.MapFloatAction
*/
protected float runMapping(MapFloatAction action) {
return (Float) runMappingPrimitive(action);
}
/**
* To map double component's method.
*
* @param action a mapping action.
* @return an action result.
* @see #runMapping(Operator.MapAction)
* @see Operator.MapDoubleAction
*/
protected double runMapping(MapDoubleAction action) {
return (Double) runMappingPrimitive(action);
}
/**
* To map boolean component's method.
*
* @param action a mapping action.
* @return an action result.
* @see #runMapping(Operator.MapAction)
* @see Operator.MapBooleanAction
*/
protected boolean runMapping(MapBooleanAction action) {
return (Boolean) runMappingPrimitive(action);
}
/**
* To map void component's method.
*
* @param action a mapping action.
* @see #runMapping(Operator.MapAction)
* @see Operator.MapVoidAction
*/
protected void runMapping(MapVoidAction action) {
runMappingPrimitive(action);
}
/**
* Adds array of objects to dump hashtable. Is used for multiple properties
* such as list items and tree nodes.
*
* @param table a table to add properties to.
* @param title property names prefix. Property names are constructed by
* adding a number to the prefix:
* {@code title + "_" + Iteger.toString("ordinal index")}
* @param items an array of property values.
* @return an array of property names (with added numbers).
*/
protected String[] addToDump(Hashtable<String, Object> table, String title, Object[] items) {
String[] names = createNames(title + "_", items.length);
for (int i = 0; i < items.length; i++) {
table.put(names[i], items[i].toString());
}
return names;
}
/**
* Adds two dimentional array of objects to dump hashtable. Is used for
* multiple properties such as table cells.
*
* @param table a table to add properties to.
* @param title property names prefix. Property names are constructed by
* adding two numbers to the prefix:
* {@code title + "_" + Iteger.toString("row index") + "_" + Iteger.toString("column index")}
* @param items an array of property values.
* @return an array of property names (with added numbers).
*/
protected String[] addToDump(Hashtable<String, Object> table, String title, Object[][] items) {
String[] names = createNames(title + "_", items.length);
for (int i = 0; i < items.length; i++) {