performed javacscript:fix and worked on documentation
[taxeditor.git] / taxeditor-store / src / main / java / eu / etaxonomy / taxeditor / model / CdmProgressMonitorAdapter.java
index f0fc345d9acad5d13dea9a079c56eb2416c14c4f..dab76d90a3413e49011036bb40cace6d769dc4a8 100644 (file)
@@ -7,7 +7,8 @@ import eu.etaxonomy.cdm.common.IProgressMonitor;
 import eu.etaxonomy.taxeditor.store.StoreUtil;
 
 /**
- * 
+ * <p>CdmProgressMonitorAdapter class.</p>
+ *
  * @author n.hoffmann
  * @created Sep 17, 2010
  * @version 1.0
@@ -20,55 +21,77 @@ public class CdmProgressMonitorAdapter implements IProgressMonitor {
                this.progressMonitor = monitor;
        }
        
+       /**
+        * <p>CreateMonitor</p>
+        *
+        * @param monitor a {@link org.eclipse.core.runtime.IProgressMonitor} object.
+        * @return a {@link eu.etaxonomy.taxeditor.model.CdmProgressMonitorAdapter} object.
+        */
        public static CdmProgressMonitorAdapter CreateMonitor (org.eclipse.core.runtime.IProgressMonitor monitor){
                return new CdmProgressMonitorAdapter(monitor);
        }
        
+       /**
+        * <p>CreateSubMonitor</p>
+        *
+        * @param monitor a {@link org.eclipse.core.runtime.IProgressMonitor} object.
+        * @param ticks a int.
+        * @return a {@link eu.etaxonomy.taxeditor.model.CdmProgressMonitorAdapter} object.
+        */
        public static CdmProgressMonitorAdapter CreateSubMonitor (org.eclipse.core.runtime.IProgressMonitor monitor, int ticks) {
                org.eclipse.core.runtime.IProgressMonitor subMonitor = StoreUtil.getSubProgressMonitor(monitor, ticks);
                return new CdmProgressMonitorAdapter(subMonitor);
        }
        
+       /** {@inheritDoc} */
        @Override
        public void beginTask(String name, int totalWork) {
                progressMonitor.beginTask(name, totalWork);
        }
 
+       /** {@inheritDoc} */
        @Override
        public void done() {
                progressMonitor.done();
        }
 
+       /** {@inheritDoc} */
        @Override
        public boolean isCanceled() {
                return progressMonitor.isCanceled();
        }
 
+       /** {@inheritDoc} */
        @Override
        public void setCanceled(boolean value) {
                progressMonitor.setCanceled(value);
        }
 
+       /** {@inheritDoc} */
        @Override
        public void setTaskName(String name) {
                progressMonitor.setTaskName(name);
        }
 
+       /** {@inheritDoc} */
        @Override
        public void subTask(String name) {
                progressMonitor.subTask(name);
        }
 
+       /** {@inheritDoc} */
        @Override
        public void worked(int work) {
                progressMonitor.worked(work);
        }
 
+       /** {@inheritDoc} */
        @Override
        public void warning(String message) {
                StoreUtil.warn(this.getClass(), message);
        }
 
+       /** {@inheritDoc} */
        @Override
        public void warning(String message, Throwable throwable) {
                StoreUtil.error(this.getClass(), message, throwable);