View Javadoc

1   /*
2    *  XNap Commons
3    *
4    *  Copyright (C) 2005  Steffen Pingel
5    *
6    *  This library is free software; you can redistribute it and/or
7    *  modify it under the terms of the GNU Lesser General Public
8    *  License as published by the Free Software Foundation; either
9    *  version 2.1 of the License, or (at your option) any later version.
10   *
11   *  This library 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 GNU
14   *  Lesser General Public License for more details.
15   *
16   *  You should have received a copy of the GNU Lesser General Public
17   *  License along with this library; if not, write to the Free Software
18   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19   */
20  package org.xnap.commons.io;
21  
22  import java.awt.Component;
23  
24  /***
25   * Null pattern implementation of the {@link ProgressMonitor} interface.
26   */
27  public class NullProgressMonitor implements ProgressMonitor {
28  
29  	/***
30  	 * Static instance that can be used so no new null monitors have to be 
31  	 * allocated.
32  	 */
33  	public static final NullProgressMonitor MONITOR = new NullProgressMonitor(); 
34  	
35  	/***
36  	 * Returns <code>false</code>.
37  	 */
38  	public boolean isCancelled()
39  	{
40  		return false;
41  	}
42  
43  	/***
44  	 * Does nothing.
45  	 */
46  	public void setCancelEnabled(boolean enabled)
47  	{
48  	}
49  
50  	/***
51  	 * Does nothing.
52  	 */
53  	public void setTotalSteps(long max)
54  	{
55  	}
56  
57  	/***
58  	 * Does nothing.
59  	 */
60  	public void setValue(long value)
61  	{
62  	}
63  
64  	/***
65  	 * Does nothing.
66  	 */
67  	public void setText(String text)
68  	{
69  	}
70  
71  	/***
72  	 * Does nothing.
73  	 */
74  	public void work(long amount)
75  	{
76  	}
77  
78  	/***
79  	 * Returns <code>null</code>.
80  	 */
81  	public Component getComponent()
82  	{
83  		return null;
84  	}
85  	
86  }