View Javadoc

1   /*
2    * Copyright (c) 2003-2008 by Cosylab d. d.
3    *
4    * This file is part of Java-Common.
5    *
6    * Java-Common is free software: you can redistribute it and/or modify
7    * it under the terms of the GNU General Public License as published by
8    * the Free Software Foundation, either version 3 of the License, or
9    * (at your option) any later version.
10   *
11   * Java-Common is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   * GNU General Public License for more details.
15   *
16   * You should have received a copy of the GNU General Public License
17   * along with Java-Common.  If not, see <http://www.gnu.org/licenses/>.
18   */
19  
20  package com.cosylab.util;
21  
22  /**
23   * Objects implementing this interface control a process which can be suspended
24   * on request.
25   *
26   * @author <a href="mailto:miha.kadunc@cosylab.com">Miha Kadunc</a>
27   * @version $id$
28   */
29  public interface Suspendable
30  {
31  	/**
32  	 * Sets the <code>suspended</code> property of the object to provided
33  	 * boolean value.
34  	 */
35  	void setSuspended(boolean suspended);
36  
37  	/**
38  	 * Returns the value of the <code>suspended</code> property of this object.
39  	 *
40  	 * @return DOCUMENT ME!
41  	 */
42  	boolean isSuspended();
43  }
44  
45  /* __oOo__ */