001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s): Alexandre Iline.
025: *
026: * The Original Software is the Jemmy library.
027: * The Initial Developer of the Original Software is Alexandre Iline.
028: * All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: *
041: *
042: *
043: * $Id$ $Revision$ $Date$
044: *
045: */
046:
047: package org.netbeans.jemmy;
048:
049: /**
050: * Represents one timeout.
051: * @author Alexandre Iline (alexandre.iline@sun.com)
052: */
053:
054: public class Timeout extends Object {
055: private String name;
056: private long value;
057: private long startTime;
058:
059: /**
060: * Constructor.
061: * @param name Timeout name.
062: * @param value Timeout value in milliseconds.
063: */
064: public Timeout(String name, long value) {
065: this .name = name;
066: this .value = value;
067: }
068:
069: /**
070: * Returns timeout name.
071: * @return timeout name.
072: */
073: public String getName() {
074: return (name);
075: }
076:
077: /**
078: * Returns timeout value.
079: * @return timeout value.
080: */
081: public long getValue() {
082: return (value);
083: }
084:
085: /**
086: * Sleeps for timeout value.
087: */
088: public void sleep() {
089: if (getValue() > 0) {
090: try {
091: Thread.currentThread().sleep(getValue());
092: } catch (InterruptedException e) {
093: throw (new JemmyException("Sleep " + getName()
094: + " was interrupted!", e));
095: }
096: }
097: }
098:
099: /**
100: * Starts timeout measuring.
101: */
102: public void start() {
103: startTime = System.currentTimeMillis();
104: }
105:
106: /**
107: * Checks if timeout has been expired after start() invocation.
108: * @return true if timeout has been expired.
109: */
110: public boolean expired() {
111: return (System.currentTimeMillis() - startTime > getValue());
112: }
113:
114: /**
115: * Throws a TimeoutExpiredException exception if timeout has been expired.
116: * @throws TimeoutExpiredException if timeout has been expired after start() invocation.
117: */
118: public void check() {
119: if (expired()) {
120: throw (new TimeoutExpiredException(getName()
121: + " timeout expired!"));
122: }
123: }
124: }
|