/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Contributor(s): Alexandre Iline.
*
* The Original Software is the Jemmy library.
* The Initial Developer of the Original Software is Alexandre Iline.
* All Rights Reserved.
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*
*
*
* $Id: Timeout.java,v 1.4 2007/10/05 11:36:11 jskrivanek Exp $ $Revision: 1.4 $ $Date: 2007/10/05 11:36:11 $
*
*/
package org.netbeans.jemmy;
/**
* Represents one timeout.
* @author Alexandre Iline (alexandre.iline@sun.com)
*/
public class Timeout extends Object {
private String name;
private long value;
private long startTime;
/**
* Constructor.
* @param name Timeout name.
* @param value Timeout value in milliseconds.
*/
public Timeout(String name, long value) {
this.name = name;
this.value = value;
}
/**
* Returns timeout name.
* @return timeout name.
*/
public String getName() {
return(name);
}
/**
* Returns timeout value.
* @return timeout value.
*/
public long getValue() {
return(value);
}
/**
* Sleeps for timeout value.
*/
public void sleep() {
if(getValue()>0) {
try {
Thread.currentThread().sleep(getValue());
} catch(InterruptedException e) {
throw(new JemmyException("Sleep " +
getName() +
" was interrupted!",
e));
}
}
}
/**
* Starts timeout measuring.
*/
public void start() {
startTime = System.currentTimeMillis();
}
/**
* Checks if timeout has been expired after start() invocation.
* @return true if timeout has been expired.
*/
public boolean expired() {
return(System.currentTimeMillis() - startTime > getValue());
}
/**
* Throws a TimeoutExpiredException exception if timeout has been expired.
* @throws TimeoutExpiredException if timeout has been expired after start() invocation.
*/
public void check() {
if(expired()) {
throw(new TimeoutExpiredException(getName() +
" timeout expired!"));
}
}
}
|