directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From seelm...@apache.org
Subject svn commit: r518768 - in /directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui: perspective/ search/ valueeditors/ valueeditors/internal/
Date Thu, 15 Mar 2007 21:58:30 GMT
Author: seelmann
Date: Thu Mar 15 14:58:29 2007
New Revision: 518768

URL: http://svn.apache.org/viewvc?view=rev&rev=518768
Log:
Code cleaning, Javadocs.

Modified:
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/perspective/BrowserPerspective.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/search/SearchPage.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogBinaryValueEditor.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogStringValueEditor.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogValueEditor.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractInPlaceStringValueEditor.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/IValueEditor.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/AddressValueEditor.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/DnValueEditor.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/HexValueEditor.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ImageValueEditor.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/InPlaceGeneralizedTimeValueEditor.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/MultivaluedValueEditor.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ObjectClassValueEditor.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/PasswordValueEditor.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/TextValueEditor.java
    directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ValueEditorManager.java

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/perspective/BrowserPerspective.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/perspective/BrowserPerspective.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/perspective/BrowserPerspective.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/perspective/BrowserPerspective.java
Thu Mar 15 14:58:29 2007
@@ -36,15 +36,30 @@
 import org.eclipse.ui.IPerspectiveFactory;
 
 
+/**
+ * This class implements the {@link IPerspectiveFactory} for the browser
+ * plugin. It is responsible for creating the perspective layout.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
 public class BrowserPerspective implements IPerspectiveFactory
 {
 
+    /**
+     * Gets the ID of the browser perspective.
+     * 
+     * @return the ID of the browser perspective
+     */
     public static String getId()
     {
         return BrowserPerspective.class.getName();
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void createInitialLayout( IPageLayout layout )
     {
         defineActions( layout );
@@ -55,9 +70,13 @@
     }
 
 
+    /**
+     * Defines the actions in the "New..." menu and the "Show views..." menu.
+     * 
+     * @param layout the layout
+     */
     private void defineActions( IPageLayout layout )
     {
-
         // Add "new wizards".
         layout.addNewWizardShortcut( NewConnectionWizard.getId() );
         layout.addNewWizardShortcut( NewEntryWizard.getId() );
@@ -75,6 +94,11 @@
     }
 
 
+    /**
+     * Defines the layout.
+     * 
+     * @param layout the layout
+     */
     private void defineLayout( IPageLayout layout )
     {
 

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/search/SearchPage.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/search/SearchPage.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/search/SearchPage.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/search/SearchPage.java
Thu Mar 15 14:58:29 2007
@@ -28,7 +28,6 @@
 import org.apache.directory.ldapstudio.browser.ui.widgets.WidgetModifyEvent;
 import org.apache.directory.ldapstudio.browser.ui.widgets.WidgetModifyListener;
 import org.apache.directory.ldapstudio.browser.ui.widgets.search.SearchPageWrapper;
-
 import org.eclipse.jface.dialogs.DialogPage;
 import org.eclipse.jface.dialogs.IDialogConstants;
 import org.eclipse.jface.resource.ImageDescriptor;
@@ -40,71 +39,110 @@
 import org.eclipse.ui.PlatformUI;
 
 
+/**
+ * This class implements the {@link ISearchPage} to perform an LDAP search.
+ * It uses the {@link SearchPageWrapper} to render all UI elements. 
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$, $Date$
+ */
 public class SearchPage extends DialogPage implements ISearchPage, WidgetModifyListener
 {
 
+    /** The search page container. */
     private ISearchPageContainer container;
 
+    /** The search. */
     private ISearch search;
 
+    /** The search page wrapper. */
     private SearchPageWrapper spw;
 
 
+    /**
+     * Gets the ID of the LDAP search page.
+     * 
+     * @return the ID of the LDAP search page
+     */
     public static String getId()
     {
         return SearchPage.class.getName();
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void dispose()
     {
-        this.spw.removeWidgetModifyListener( this );
+        spw.removeWidgetModifyListener( this );
         super.dispose();
     }
 
 
+    /**
+     * Creates a new instance of SearchPage.
+     */
     public SearchPage()
     {
-        super();
     }
 
 
+    /**
+     * Creates a new instance of SearchPage.
+     * 
+     * @param title the title
+     */
     public SearchPage( String title )
     {
         super( title );
     }
 
 
+    /**
+     * Creates a new instance of SearchPage.
+     * 
+     * @param title the title
+     * @param image the image
+     */
     public SearchPage( String title, ImageDescriptor image )
     {
         super( title, image );
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public boolean performAction()
     {
-        this.spw.saveToSearch( this.search );
-        if ( this.search.getConnection() != null )
+        spw.saveToSearch( search );
+        if ( search.getConnection() != null )
         {
-            this.search.getConnection().getSearchManager().addSearch( this.search );
-            return this.spw.performSearch( this.search );
+            search.getConnection().getSearchManager().addSearch( search );
+            return spw.performSearch( search );
         }
 
         return false;
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void setContainer( ISearchPageContainer container )
     {
         this.container = container;
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void createControl( Composite parent )
     {
-
         // declare search
-        this.search = SelectionUtils.getExampleSearch( this.container.getSelection() );
+        search = SelectionUtils.getExampleSearch( container.getSelection() );
 
         // create search page content
         GridLayout gl = new GridLayout();
@@ -116,11 +154,11 @@
         parent.setLayoutData( gd );
 
         Composite composite = BaseWidgetUtils.createColumnContainer( parent, 3, 1 );
-        this.spw = new SearchPageWrapper( SearchPageWrapper.NONE );
-        this.spw.createContents( composite );
-        this.spw.loadFromSearch( this.search );
-        this.spw.addWidgetModifyListener( this );
-        
+        spw = new SearchPageWrapper( SearchPageWrapper.NONE );
+        spw.createContents( composite );
+        spw.loadFromSearch( search );
+        spw.addWidgetModifyListener( this );
+
         PlatformUI.getWorkbench().getHelpSystem().setHelp( composite,
             BrowserUIPlugin.PLUGIN_ID + "." + "tools_search_dialog" );
         PlatformUI.getWorkbench().getHelpSystem().setHelp( parent,
@@ -130,16 +168,22 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void setVisible( boolean visible )
     {
-        this.container.setPerformActionEnabled( this.spw.isValid() );
+        container.setPerformActionEnabled( spw.isValid() );
         super.setVisible( visible );
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public void widgetModified( WidgetModifyEvent event )
     {
-        this.container.setPerformActionEnabled( this.spw.isValid() );
+        container.setPerformActionEnabled( spw.isValid() );
     }
 
 }

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogBinaryValueEditor.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogBinaryValueEditor.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogBinaryValueEditor.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogBinaryValueEditor.java
Thu Mar 15 14:58:29 2007
@@ -47,13 +47,17 @@
 public abstract class AbstractDialogBinaryValueEditor extends AbstractDialogValueEditor
 {
 
+    /**
+     * Creates a new instance of AbstractDialogBinaryValueEditor.
+     */
     protected AbstractDialogBinaryValueEditor()
     {
-        super();
     }
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation of getDisplayValue just returns a note,
      * that the value is binary and the size of the data.
      */
@@ -83,8 +87,12 @@
 
 
     /**
-     * Help method, returns a printable string if the value 
+     * Helper method, returns a printable string if the value
      * is binary.
+     * 
+     * @param value the value
+     * 
+     * @return the printable string
      */
     public static String getPrintableString( IValue value )
     {
@@ -117,6 +125,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation returns IValue.EMPTY_BINARY_VALUE if
      * the attribute is binary.
      */
@@ -134,6 +144,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation returns the binary (byte[]) value 
      * of the given value. 
      */
@@ -159,6 +171,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation returns the value itself if it is
      * of type byte[] or a byte[] with the UTF-8 encoded string 
      * value if it is of type String.  
@@ -185,6 +199,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation always return the binary value
      * as byte[].
      */
@@ -241,9 +257,6 @@
     }
 
 
-    /**
-     * {@inheritDoc}
-     */
     private final void modify( IAttribute attribute, Object newRawValue ) throws ModelModificationException
     {
         if ( attribute != null && newRawValue != null && newRawValue instanceof
byte[] )

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogStringValueEditor.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogStringValueEditor.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogStringValueEditor.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogStringValueEditor.java
Thu Mar 15 14:58:29 2007
@@ -46,6 +46,9 @@
 public abstract class AbstractDialogStringValueEditor extends AbstractDialogValueEditor
 {
 
+    /**
+     * Creates a new instance of AbstractDialogStringValueEditor.
+     */
     protected AbstractDialogStringValueEditor()
     {
         super();
@@ -53,6 +56,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation just returns the raw value
      */
     public String getDisplayValue( IValue value )
@@ -63,6 +68,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation returns IValue.EMPTY_STRING_VALUE if
      * the attribute is string.
      */
@@ -80,6 +87,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation returns the string value 
      * of the given value. 
      */
@@ -105,6 +114,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation returns the value itself if it is
      * of type String. If the value is of type byte[] then the binary
      * data is converted to a String using UTF-8 encoding.  
@@ -161,6 +172,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation always return the string value
      * as String.
      */
@@ -217,9 +230,6 @@
     }
 
 
-    /**
-     * {@inheritDoc}
-     */
     private final void modify( IAttribute attribute, Object newRawValue ) throws ModelModificationException
     {
         if ( attribute != null && newRawValue != null && newRawValue instanceof
String )

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogValueEditor.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogValueEditor.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogValueEditor.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractDialogValueEditor.java
Thu Mar 15 14:58:29 2007
@@ -64,8 +64,6 @@
     /**
      * 
      * Creates a new instance of AbstractDialogEditor.
-     *
-     * @param parent The parent composite, used to open the dialog.
      */
     protected AbstractDialogValueEditor()
     {
@@ -87,9 +85,9 @@
 
 
     /**
-     * This implementation simple returns itself.
+     * {@inheritDoc}
      * 
-     * @see IValueEditor.getCellEditor()
+     * This implementation simple returns itself.
      */
     public CellEditor getCellEditor()
     {
@@ -98,6 +96,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This is a dialog editor, it doesn't create a control. 
      * It just extracts and saves the shell reference from parent.
      */
@@ -109,6 +109,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This is a dialog editor, doesn't set focus. 
      */
     protected final void doSetFocus()
@@ -117,6 +119,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns the value object stored in a member.
      */
     protected final Object doGetValue()
@@ -126,6 +130,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Stores the value object in a member.
      */
     protected final void doSetValue( Object value )
@@ -143,9 +149,10 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * The activate method is called from the JFace framework
      * to start editing. 
-     * 
      */
     public final void activate()
     {
@@ -180,12 +187,14 @@
      * Returns a raw value that represents an empty value.
      * 
      * @param attribute the attribute
-     * @return 
+     * @return a raw value that represents an empty value
      */
     protected abstract Object getEmptyRawValue( IAttribute attribute );
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation of getDisplayValue() returns a 
      * comma-separated list of all values. 
      */
@@ -216,6 +225,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation calls getEmptyRawValue(IAttribute) if there are no values
      * in attributeHierarchy and getRawValue(IValue) if attributeHierarchy
      * contains exactly one value. Otherwise null is returned.

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractInPlaceStringValueEditor.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractInPlaceStringValueEditor.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractInPlaceStringValueEditor.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/AbstractInPlaceStringValueEditor.java
Thu Mar 15 14:58:29 2007
@@ -65,6 +65,9 @@
     private ImageDescriptor imageDescriptor;
 
 
+    /**
+     * Creates a new instance of AbstractInPlaceStringValueEditor.
+     */
     protected AbstractInPlaceStringValueEditor()
     {
         super();
@@ -87,6 +90,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation of getDisplayValue() returns a 
      * comma-separated list of all values. 
      */
@@ -117,6 +122,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation just returns the raw value
      */
     public String getDisplayValue( IValue value )
@@ -127,6 +134,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation returns IValue.EMPTY_xx_VALUE if there are no values
      * in attributeHierarchy or calls getRawValue(IValue) if attributeHierarchy
      * contains exactly one value. Otherwise null is returned.
@@ -160,6 +169,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation returns the string value 
      * of the given value. 
      */
@@ -207,6 +218,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation returns the value itself if it is
      * of type byte[] or a byte[] with the UTF-8 encoded string
      * value if it is of type String.  
@@ -241,6 +254,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation always return the string value
      * as String.
      */
@@ -261,18 +276,27 @@
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     public CellEditor getCellEditor()
     {
         return this;
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     protected Object doGetValue()
     {
         return "".equals( text.getText() ) ? null : text.getText();
     }
 
 
+    /**
+     * {@inheritDoc}
+     */
     protected void doSetValue( Object value )
     {
         if ( value != null && value instanceof IValue.EmptyValue )

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/IValueEditor.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/IValueEditor.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/IValueEditor.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/IValueEditor.java
Thu Mar 15 14:58:29 2007
@@ -34,7 +34,7 @@
 /**
  * A ValueEditor knows how to display and edit values of a LDAP attribute.
  * ValueEditors are used from the entry editor or search result editor 
- * to display values to edit values in a user-friendly way.  
+ * to display and edit values in a user-friendly way.  
  *
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
  * @version $Rev$, $Date$
@@ -119,10 +119,10 @@
      * could be used for editors handling connection-dependent values. 
      * 
      * @param connection the connection
-     * @param value the value either String or byte[]
+     * @param stringOrBinaryValue the value either String or byte[]
      * @return the raw value of the value or null
      */
-    public abstract Object getRawValue( IConnection connecton, Object stringOrBinaryValue
);
+    public abstract Object getRawValue( IConnection connection, Object stringOrBinaryValue
);
 
 
     /**
@@ -217,11 +217,11 @@
      * It is called from a ICellModfier if the attribute exists and the raw
      * value returned by the CellEditor is null.
      * 
-     * @param attributes
+     * @param attributeHierarchy the attribute hierarchy
      * @throws ModelModificationException
      * @deprecated This functionality will be removed from IValueEditor soon.
      */
-    public abstract void deleteAttribute( AttributeHierarchy ah ) throws ModelModificationException;
+    public abstract void deleteAttribute( AttributeHierarchy attributeHierarchy ) throws
ModelModificationException;
 
 
     /**

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/AddressValueEditor.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/AddressValueEditor.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/AddressValueEditor.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/AddressValueEditor.java
Thu Mar 15 14:58:29 2007
@@ -41,6 +41,8 @@
 {
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation opens the AddressDialog.
      */
     protected boolean openDialog( Shell shell )
@@ -60,6 +62,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementatiosn replaces the $ separators by commas.
      */
     public String getDisplayValue( IValue value )

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/DnValueEditor.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/DnValueEditor.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/DnValueEditor.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/DnValueEditor.java
Thu Mar 15 14:58:29 2007
@@ -43,6 +43,8 @@
 {
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation opens the DnDialog.
      */
     protected boolean openDialog( Shell shell )
@@ -63,6 +65,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns a DnValueEditorRawValueWrapper with the connection of 
      * the attribute hierarchy and a null DN if there are no values
      * in attributeHierarchy.
@@ -104,6 +108,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns a DnValueEditorRawValueWrapper with the connection of 
      * the value and a DN build from the given value. 
      * 
@@ -132,6 +138,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns a DnValueEditorRawValueWrapper with the given 
      * connection and a DN build from the given value.
      * 
@@ -159,6 +167,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns always the string value.
      * 
      * Reimplementation, because getRawValue() returns a 

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/HexValueEditor.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/HexValueEditor.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/HexValueEditor.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/HexValueEditor.java
Thu Mar 15 14:58:29 2007
@@ -40,6 +40,8 @@
 {
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation opens the HexDialog.
      */
     protected boolean openDialog( Shell shell )

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ImageValueEditor.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ImageValueEditor.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ImageValueEditor.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ImageValueEditor.java
Thu Mar 15 14:58:29 2007
@@ -40,6 +40,8 @@
 {
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation opens the ImageDialog.
      */
     protected boolean openDialog( Shell shell )
@@ -62,6 +64,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns the image info text created by 
      * ImageDialog.getImageInfo().
      */

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/InPlaceGeneralizedTimeValueEditor.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/InPlaceGeneralizedTimeValueEditor.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/InPlaceGeneralizedTimeValueEditor.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/InPlaceGeneralizedTimeValueEditor.java
Thu Mar 15 14:58:29 2007
@@ -44,6 +44,8 @@
 {
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns the proper formatted date and time, Timezone is 
      * convertet to the default locale. 
      * 

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/MultivaluedValueEditor.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/MultivaluedValueEditor.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/MultivaluedValueEditor.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/MultivaluedValueEditor.java
Thu Mar 15 14:58:29 2007
@@ -81,6 +81,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This is a dialog editor, it doesn't create a control. 
      */
     protected Control createControl( Composite parent )
@@ -90,6 +92,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns the value object stored in a member.
      */
     protected final Object doGetValue()
@@ -99,6 +103,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This is a dialog editor, doesn't set focus. 
      */
     protected void doSetFocus()
@@ -107,6 +113,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Stores the value object in a member.
      */
     protected void doSetValue( Object value )
@@ -116,6 +124,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Opens the MulitvaluedDialog. Expects that an AttributeHierarchy
      * object is in value member. 
      */
@@ -136,6 +146,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns this.
      */
     public CellEditor getCellEditor()
@@ -145,6 +157,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation of getDisplayValue() returns a 
      * comma-separated list of all values. 
      */
@@ -174,6 +188,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * It doesn't make sense to use the MultivaluedValueEditor with a single value.
      * Returns an empty string.
      */
@@ -184,6 +200,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns the attributeHierarchy.
      */
     public Object getRawValue( AttributeHierarchy attributeHierarchy )
@@ -193,6 +211,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * It doesn't make sense to use the MultivaluedValueEditor with a single value.
      * Returns null.
      */
@@ -203,6 +223,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * It doesn't make sense to use the MultivaluedValueEditor with a single value.
      * Returns null.
      */
@@ -213,6 +235,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Modification is performed in the concrete single-ValueEditors.
      */
     public void modifyValue( IValue oldValue, Object newRawValue ) throws ModelModificationException
@@ -221,6 +245,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Creationg is performed in the concrete single-ValueEditors.
      */
     public void createValue( IEntry entry, String attributeName, Object newRawValue ) throws
ModelModificationException
@@ -229,6 +255,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Deletion is performed in the concrete single-ValueEditors.
      */
     public void deleteAttribute( AttributeHierarchy ah ) throws ModelModificationException
@@ -237,6 +265,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Deletion is performed in the concrete single-ValueEditors.
      */
     public void deleteValue( IValue oldValue ) throws ModelModificationException
@@ -245,6 +275,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Modification is performed in the concrete single-ValueEditors. No need 
      * to return a value.
      */
@@ -254,8 +286,8 @@
     }
 
 
-    /*
-     * @see org.apache.directory.ldapstudio.browser.ui.valueeditors.IValueEditor#setValueEditorName(java.lang.String)
+    /**
+     * {@inheritDoc}
      */
     public void setValueEditorName( String name )
     {
@@ -263,8 +295,8 @@
     }
 
 
-    /*
-     * @see org.apache.directory.ldapstudio.browser.ui.valueeditors.IValueEditor#getValueEditorName()
+    /**
+     * {@inheritDoc}
      */
     public String getValueEditorName()
     {
@@ -272,8 +304,8 @@
     }
 
 
-    /*
-     * @see org.apache.directory.ldapstudio.browser.ui.valueeditors.IValueEditor#setValueEditorImageDescriptor(org.eclipse.jface.resource.ImageDescriptor)
+    /**
+     * {@inheritDoc}
      */
     public void setValueEditorImageDescriptor( ImageDescriptor imageDescriptor )
     {
@@ -281,8 +313,8 @@
     }
 
 
-    /*
-     * @see org.apache.directory.ldapstudio.browser.ui.valueeditors.IValueEditor#getValueEditorImageDescriptor()
+    /**
+     * {@inheritDoc}
      */
     public ImageDescriptor getValueEditorImageDescriptor()
     {

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ObjectClassValueEditor.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ObjectClassValueEditor.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ObjectClassValueEditor.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ObjectClassValueEditor.java
Thu Mar 15 14:58:29 2007
@@ -42,6 +42,8 @@
 {
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation opens the ObjectClassDialog.
      */
     public boolean openDialog( Shell shell )
@@ -62,6 +64,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation appends the kind of object class,
      * on of structural, abstract, auxiliary or obsolete. 
      * 
@@ -104,6 +108,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns null.
      * Modification in search result editor not supported.
      */
@@ -114,6 +120,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns a ObjectClassValueEditorRawValueWrapper.
      */
     public Object getRawValue( IValue value )
@@ -130,6 +138,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns a ObjectClassValueEditorRawValueWrapper.
      */
     public Object getRawValue( IConnection connection, Object value )

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/PasswordValueEditor.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/PasswordValueEditor.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/PasswordValueEditor.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/PasswordValueEditor.java
Thu Mar 15 14:58:29 2007
@@ -41,6 +41,8 @@
 {
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation opens the PasswordDialog.
      */
     protected boolean openDialog( Shell shell )
@@ -65,6 +67,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation returns information about the 
      * used hash algorithm. The value stored in directory
      * is only display when the showRawValues option is 
@@ -111,6 +115,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns a PasswordValueEditorRawValueWrapper with empty 
      * password.
      */
@@ -121,6 +127,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns a PasswordValueEditorRawValueWrapper.
      */
     public Object getRawValue( IValue value )
@@ -131,6 +139,8 @@
 
 
     /**
+     * {@inheritDoc}
+     * 
      * Returns a PasswordValueEditorRawValueWrapper with 
      * null entry.
      */

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/TextValueEditor.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/TextValueEditor.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/TextValueEditor.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/TextValueEditor.java
Thu Mar 15 14:58:29 2007
@@ -36,6 +36,8 @@
 {
 
     /**
+     * {@inheritDoc}
+     * 
      * This implementation opens the TextDialog.
      */
     public boolean openDialog( Shell shell )

Modified: directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ValueEditorManager.java
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ValueEditorManager.java?view=diff&rev=518768&r1=518767&r2=518768
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ValueEditorManager.java
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-ui/src/main/java/org/apache/directory/ldapstudio/browser/ui/valueeditors/internal/ValueEditorManager.java
Thu Mar 15 14:58:29 2007
@@ -233,7 +233,7 @@
      * @param entry the entry
      * @param attributeType the attributge type
      * @return the current value editor
-     * @see getCurrentValueEditor( Schema, String )
+     * @see #getCurrentValueEditor( Schema, String )
      */
     public IValueEditor getCurrentValueEditor( IEntry entry, String attributeType )
     {
@@ -246,7 +246,7 @@
      * 
      * @param value the value
      * @return the current value editor
-     * @see getCurrentValueEditor( Schema, String )
+     * @see #getCurrentValueEditor( Schema, String )
      */
     public IValueEditor getCurrentValueEditor( IValue value )
     {
@@ -276,7 +276,7 @@
      * 
      * @param attributeHierarchy the attribute hierarchy
      * @return the current value editor
-     * @see getCurrentValueEditor( Schema, String )
+     * @see #getCurrentValueEditor( Schema, String )
      */
     public IValueEditor getCurrentValueEditor( AttributeHierarchy attributeHierarchy )
     {
@@ -396,9 +396,9 @@
     /**
      * Returns alternative value editors for the given value. For now these
      * are the three default editors.
-     *
-     * @param objectClass the value
-     * @return lternative value editors
+     * 
+     * @param ah the attribute hierarchy
+     * @return alternative value editors
      */
     public IValueEditor[] getAlternativeValueEditors( AttributeHierarchy ah )
     {
@@ -491,8 +491,8 @@
     /**
      * Creates and returns the value editors specified by value editors extensions.
      *
-     * @param parent
-     * @return
+     * @param parent the parent composite
+     * @return the value editors
      */
     private Collection<IValueEditor> createValueEditors( Composite parent )
     {
@@ -524,7 +524,7 @@
     /**
      * Returns all value editor proxies specified by value editor extensions.
      *
-     * @return
+     * @return the value editor proxies
      */
     public static Collection<ValueEditorExtension> getValueEditorProxys()
     {
@@ -583,12 +583,23 @@
      */
     public static class ValueEditorExtension
     {
+        
+        /** The name. */
         public String name = null;
+        
+        /** The icon. */
         public ImageDescriptor icon = null;
+        
+        /** The class name. */
         public String className = null;
+        
+        /** The syntax oids. */
         public Collection<String> syntaxOids = new ArrayList<String>( 3 );
+        
+        /** The attribute types. */
         public Collection<String> attributeTypes = new ArrayList<String>( 3 );
 
+        /** The configuration element. */
         private IConfigurationElement member = null;
     }
 



Mime
View raw message