svn commit: r650132 - /lenya/trunk/src/modules-core/sitemanagement/java/src/org/apache/lenya/cms/metadata/usecases/Metadata.java

Author: andreas
Date: Mon Apr 21 05:55:12 2008
New Revision: 650132

URL: http://svn.apache.org/viewvc?rev=650132&view=rev
Log:
[minor change] adding javadoc comments

Modified:
    lenya/trunk/src/modules-core/sitemanagement/java/src/org/apache/lenya/cms/metadata/usecases/Metadata.java

Modified: lenya/trunk/src/modules-core/sitemanagement/java/src/org/apache/lenya/cms/metadata/usecases/Metadata.java
URL: http://svn.apache.org/viewvc/lenya/trunk/src/modules-core/sitemanagement/java/src/org/apache/lenya/cms/metadata/usecases/Metadata.java?rev=650132&r1=650131&r2=650132&view=diff
==============================================================================
--- lenya/trunk/src/modules-core/sitemanagement/java/src/org/apache/lenya/cms/metadata/usecases/Metadata.java (original)
+++ lenya/trunk/src/modules-core/sitemanagement/java/src/org/apache/lenya/cms/metadata/usecases/Metadata.java Mon Apr 21 05:55:12 2008
@@ -50,26 +50,44 @@
         return objects;
     }
     
+    /**
+     * Object to pass a meta data entry to the view.
+     */
     public static class MetaDataWrapper {
         
         private String[] values;
         private Element element;
         private boolean editable;
         
+        /**
+         * @param element The element.
+         * @param values The values for the element.
+         * @param canChange If the element value can be changed via the GUI. A <code>true</code>
+         *     value is only effective if the element itself is editable.
+         */
         public MetaDataWrapper(Element element, String[] values, boolean canChange) {
             this.values = values;
             this.element = element;
             this.editable = element.isEditable() && canChange;
         }
         
+        /**
+         * @return The values for the element.
+         */
         public String[] getValues() {
             return this.values;
         }
         
+        /**
+         * @return The element.
+         */
         public Element getElement() {
             return this.element;
         }
         
+        /**
+         * @return If the value can be changed via the GUI.
+         */
         public boolean isEditable() {
             return this.editable;
         }