performed javacscript:fix and worked on documentation
[taxeditor.git] / taxeditor-store / src / main / java / eu / etaxonomy / taxeditor / model / CdmProgressMonitorAdapter.java
1 /**
2 *
3 */
4 package eu.etaxonomy.taxeditor.model;
5
6 import eu.etaxonomy.cdm.common.IProgressMonitor;
7 import eu.etaxonomy.taxeditor.store.StoreUtil;
8
9 /**
10 * <p>CdmProgressMonitorAdapter class.</p>
11 *
12 * @author n.hoffmann
13 * @created Sep 17, 2010
14 * @version 1.0
15 */
16 public class CdmProgressMonitorAdapter implements IProgressMonitor {
17
18 private org.eclipse.core.runtime.IProgressMonitor progressMonitor;
19
20 private CdmProgressMonitorAdapter (org.eclipse.core.runtime.IProgressMonitor monitor){
21 this.progressMonitor = monitor;
22 }
23
24 /**
25 * <p>CreateMonitor</p>
26 *
27 * @param monitor a {@link org.eclipse.core.runtime.IProgressMonitor} object.
28 * @return a {@link eu.etaxonomy.taxeditor.model.CdmProgressMonitorAdapter} object.
29 */
30 public static CdmProgressMonitorAdapter CreateMonitor (org.eclipse.core.runtime.IProgressMonitor monitor){
31 return new CdmProgressMonitorAdapter(monitor);
32 }
33
34 /**
35 * <p>CreateSubMonitor</p>
36 *
37 * @param monitor a {@link org.eclipse.core.runtime.IProgressMonitor} object.
38 * @param ticks a int.
39 * @return a {@link eu.etaxonomy.taxeditor.model.CdmProgressMonitorAdapter} object.
40 */
41 public static CdmProgressMonitorAdapter CreateSubMonitor (org.eclipse.core.runtime.IProgressMonitor monitor, int ticks) {
42 org.eclipse.core.runtime.IProgressMonitor subMonitor = StoreUtil.getSubProgressMonitor(monitor, ticks);
43 return new CdmProgressMonitorAdapter(subMonitor);
44 }
45
46 /** {@inheritDoc} */
47 @Override
48 public void beginTask(String name, int totalWork) {
49 progressMonitor.beginTask(name, totalWork);
50 }
51
52 /** {@inheritDoc} */
53 @Override
54 public void done() {
55 progressMonitor.done();
56 }
57
58 /** {@inheritDoc} */
59 @Override
60 public boolean isCanceled() {
61 return progressMonitor.isCanceled();
62 }
63
64 /** {@inheritDoc} */
65 @Override
66 public void setCanceled(boolean value) {
67 progressMonitor.setCanceled(value);
68 }
69
70 /** {@inheritDoc} */
71 @Override
72 public void setTaskName(String name) {
73 progressMonitor.setTaskName(name);
74 }
75
76 /** {@inheritDoc} */
77 @Override
78 public void subTask(String name) {
79 progressMonitor.subTask(name);
80 }
81
82 /** {@inheritDoc} */
83 @Override
84 public void worked(int work) {
85 progressMonitor.worked(work);
86 }
87
88 /** {@inheritDoc} */
89 @Override
90 public void warning(String message) {
91 StoreUtil.warn(this.getClass(), message);
92 }
93
94 /** {@inheritDoc} */
95 @Override
96 public void warning(String message, Throwable throwable) {
97 StoreUtil.error(this.getClass(), message, throwable);
98 }
99 }