KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > google > gwt > user > client > IncrementalCommand


1 /*
2  * Copyright 2007 Google Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License"); you may not
5  * use this file except in compliance with the License. You may obtain a copy of
6  * the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13  * License for the specific language governing permissions and limitations under
14  * the License.
15  */
16 package com.google.gwt.user.client;
17
18 /**
19  * An <code>IncrementalCommand</code> is a command that is broken into one or
20  * more substeps, each substep brings the whole command nearer to completion.
21  * The command is complete when <code>execute()</code> returns
22  * <code>false</code>.
23  *
24  * {@example com.google.gwt.examples.IncrementalCommandExample}
25  */
26 public interface IncrementalCommand {
27   /**
28    * Causes the <code>IncrementalCommand</code> to execute its encapsulated
29    * behavior.
30    *
31    * @return <code>true</code> if the command has more work to do,
32    * <code>false</code> otherwise
33    */
34   boolean execute();
35 }
36
Popular Tags