1 /*
   2  * Copyright (c) 2007, 2017 Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation. Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package org.jemmy.action;
  26 
  27 
  28 import org.jemmy.env.Environment;
  29 
  30 
  31 /**
  32  * An action to get some value.
  33  * @param <T>
  34  * @author shura
  35  */
  36 public abstract class GetAction<T> extends Action {
  37 
  38     private boolean finished = false;
  39     private T result = null;
  40 
  41     /**
  42      *
  43      */
  44     public GetAction() {
  45     }
  46 
  47     /**
  48      *
  49      * @return
  50      */
  51     public boolean isFinished() {
  52         return finished;
  53     }
  54 
  55     /**
  56      *
  57      * @return
  58      */
  59     public T getResult() {
  60         return result;
  61     }
  62 
  63     /**
  64      *
  65      * @param result
  66      */
  67     protected void setResult(T result) {
  68         this.result = result;
  69         finished = true;
  70     }
  71 
  72     /**
  73      * Dispatches action through the system UI queue to get the result.
  74      * @param env Environment to
  75      * {@linkplain Environment#getExecutor() get} executor and to pass to
  76      * {@linkplain ActionExecutor#execute(org.jemmy.env.Environment, boolean,
  77      * org.jemmy.action.Action, java.lang.Object[]) execute()} method.
  78      * @param parameters Parameters to pass to {@linkplain
  79      * #run(java.lang.Object[]) run()} method.
  80      * @return value returned by {@linkplain #getResult() getResult()} method.
  81      */
  82     public T dispatch(Environment env, Object... parameters) {
  83         env.getExecutor().execute(env, true, this, parameters);
  84         return getResult();
  85     }
  86 
  87 }