performed javacscript:fix and worked on documentation

[taxeditor.git] / taxeditor-editor / src / main / java / eu / etaxonomy / taxeditor / editor / TaxonEditorInput.java

diff --git a/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/editor/TaxonEditorInput.java b/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/editor/TaxonEditorInput.java
index 3dd925a6117463c726c18695925a45748a885a44..33d8af4cd18c20d64a76886f54ebd23e23196d05 100644 (file)
--- a/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/editor/TaxonEditorInput.java
+++ b/taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/editor/TaxonEditorInput.java
@@ -34,6 +34,8 @@ import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
 import eu.etaxonomy.taxeditor.store.CdmStore;
 
 /**
+ * <p>TaxonEditorInput class.</p>
+ *
  * @author n.hoffmann
  * @created 19.03.2009
  * @version 1.0
@@ -55,6 +57,13 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        
 
        
+       /**
+        * <p>NewInstance</p>
+        *
+        * @param taxonNodeUuid a {@link java.util.UUID} object.
+        * @return a {@link eu.etaxonomy.taxeditor.editor.TaxonEditorInput} object.
+        * @throws java.lang.Exception if any.
+        */
        public static TaxonEditorInput NewInstance(UUID taxonNodeUuid) throws Exception{
                try{
                        ConversationHolder conversation = CdmStore.createConversation();
@@ -83,6 +92,12 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        return new TaxonEditorInput(taxonNode, conversation);
     }
     
+    /**
+     * <p>NewInstanceFromTaxonBase</p>
+     *
+     * @param taxonBaseUuid a {@link java.util.UUID} object.
+     * @return a {@link eu.etaxonomy.taxeditor.editor.TaxonEditorInput} object.
+     */
     public static TaxonEditorInput NewInstanceFromTaxonBase(UUID taxonBaseUuid){
        ConversationHolder conversation = CdmStore.createConversation();
        
@@ -156,6 +171,12 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        return null;
     }
     
+    /**
+     * <p>NewEmptyInstance</p>
+     *
+     * @param parentNodeUuid a {@link java.util.UUID} object.
+     * @return a {@link eu.etaxonomy.taxeditor.editor.TaxonEditorInput} object.
+     */
     public static TaxonEditorInput NewEmptyInstance(UUID parentNodeUuid){
        ConversationHolder conversation = CdmStore.createConversation();
                
@@ -174,6 +195,11 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        /* (non-Javadoc)
         * @see org.eclipse.ui.IEditorInput#exists()
         */
+       /**
+        * <p>exists</p>
+        *
+        * @return a boolean.
+        */
        public boolean exists() {
                return taxonNode != null;
        }
@@ -181,6 +207,11 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        /* (non-Javadoc)
         * @see org.eclipse.ui.IEditorInput#getImageDescriptor()
         */
+       /**
+        * <p>getImageDescriptor</p>
+        *
+        * @return a {@link org.eclipse.jface.resource.ImageDescriptor} object.
+        */
        public ImageDescriptor getImageDescriptor() {
                return null;
        }
@@ -188,6 +219,11 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        /* (non-Javadoc)
         * @see org.eclipse.ui.IEditorInput#getName()
         */
+       /**
+        * <p>getName</p>
+        *
+        * @return a {@link java.lang.String} object.
+        */
        public String getName() {
                if(getTaxon() == null){
                        return null;
@@ -203,6 +239,11 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        /* (non-Javadoc)
         * @see org.eclipse.ui.IEditorInput#getPersistable()
         */
+       /**
+        * <p>getPersistable</p>
+        *
+        * @return a {@link org.eclipse.ui.IPersistableElement} object.
+        */
        public IPersistableElement getPersistable() {
 //             if(CdmStore.isActive()){
 //                     TaxonNode test = CdmStore.getTaxonTreeService().getTaxonNodeByUuid(taxonNode.getUuid());
@@ -217,6 +258,11 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        /* (non-Javadoc)
         * @see org.eclipse.ui.IEditorInput#getToolTipText()
         */
+       /**
+        * <p>getToolTipText</p>
+        *
+        * @return a {@link java.lang.String} object.
+        */
        public String getToolTipText() {
                return getName();
        }
@@ -224,6 +270,7 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        /* (non-Javadoc)
         * @see org.eclipse.core.runtime.IAdaptable#getAdapter(java.lang.Class)
         */
+       /** {@inheritDoc} */
        public Object getAdapter(Class adapter) {
 
                if (adapter == Taxon.class) {
@@ -237,12 +284,12 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
                return null;
        }
        
-    /**
-     * Overrides equals to ensure that a taxon can only be edited by
-     * one editor at a time.
-     * 
-     * @return boolean
-     */        
+       /**
+        * {@inheritDoc}
+        *
+        * Overrides equals to ensure that a taxon can only be edited by
+        * one editor at a time.
+        */
        public boolean equals(Object obj) {
                if (TaxonEditorInput.class.equals(obj.getClass()) 
                                && getTaxon() != null
@@ -256,6 +303,8 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        }
 
        /**
+        * <p>getTaxon</p>
+        *
         * @return the taxon
         */
        public Taxon getTaxon(){
@@ -263,6 +312,8 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        }
        
        /**
+        * <p>Getter for the field <code>taxonNode</code>.</p>
+        *
         * @return the taxonNode
         */
        public TaxonNode getTaxonNode() {
@@ -273,6 +324,11 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
         * (non-Javadoc)
         * @see eu.etaxonomy.cdm.api.conversation.IConversationEnabled#getConversationHolder()
         */
+       /**
+        * <p>getConversationHolder</p>
+        *
+        * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
+        */
        public ConversationHolder getConversationHolder() {
                return conversation;
        }
@@ -281,6 +337,7 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
         * (non-Javadoc)
         * @see eu.etaxonomy.cdm.persistence.hibernate.ICdmPostCrudObserver#update(eu.etaxonomy.cdm.persistence.hibernate.CdmCrudEvent)
         */
+       /** {@inheritDoc} */
        public void update(CdmDataChangeMap events) {
                if(dataChangeBehavior == null){
                        dataChangeBehavior = new TaxonEditorInputDataChangeBehaviour(this);
@@ -292,6 +349,11 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        /* (non-Javadoc)
         * @see org.eclipse.ui.IPersistableElement#getFactoryId()
         */
+       /**
+        * <p>getFactoryId</p>
+        *
+        * @return a {@link java.lang.String} object.
+        */
        public String getFactoryId() {
                return TaxonEditorInputFactory.getFactoryId();
        }
@@ -299,15 +361,26 @@ public class TaxonEditorInput implements IEditorInput, IConversationEnabled, IPe
        /* (non-Javadoc)
         * @see org.eclipse.ui.IPersistable#saveState(org.eclipse.ui.IMemento)
         */
+       /** {@inheritDoc} */
        public void saveState(IMemento memento) {
                TaxonEditorInputFactory.saveState(memento, this);
        }
 
     
+    /**
+     * <p>Setter for the field <code>initiallySelectedTaxonBase</code>.</p>
+     *
+     * @param taxonBase a {@link eu.etaxonomy.cdm.model.taxon.TaxonBase} object.
+     */
     public void setInitiallySelectedTaxonBase(TaxonBase taxonBase) {
                this.initiallySelectedTaxonBase = taxonBase;
        }
 
+       /**
+        * <p>Getter for the field <code>initiallySelectedTaxonBase</code>.</p>
+        *
+        * @return a {@link eu.etaxonomy.cdm.model.taxon.TaxonBase} object.
+        */
        public TaxonBase getInitiallySelectedTaxonBase() {
                return initiallySelectedTaxonBase;
        }