felix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pde...@apache.org
Subject svn commit: r919881 - in /felix/trunk/dependencymanager/core/src/main/java/org/apache/felix/dm/dependencies: ConfigurationDependency.java PropertyMetaData.java
Date Sun, 07 Mar 2010 00:03:27 GMT
Author: pderop
Date: Sun Mar  7 00:03:26 2010
New Revision: 919881

URL: http://svn.apache.org/viewvc?rev=919881&view=rev
Log:
fixed javadoc

Modified:
    felix/trunk/dependencymanager/core/src/main/java/org/apache/felix/dm/dependencies/ConfigurationDependency.java
    felix/trunk/dependencymanager/core/src/main/java/org/apache/felix/dm/dependencies/PropertyMetaData.java

Modified: felix/trunk/dependencymanager/core/src/main/java/org/apache/felix/dm/dependencies/ConfigurationDependency.java
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/core/src/main/java/org/apache/felix/dm/dependencies/ConfigurationDependency.java?rev=919881&r1=919880&r2=919881&view=diff
==============================================================================
--- felix/trunk/dependencymanager/core/src/main/java/org/apache/felix/dm/dependencies/ConfigurationDependency.java
(original)
+++ felix/trunk/dependencymanager/core/src/main/java/org/apache/felix/dm/dependencies/ConfigurationDependency.java
Sun Mar  7 00:03:26 2010
@@ -53,21 +53,22 @@
   ConfigurationDependency setHeading(String heading);
 
   /**
-   * A human readable description of the PID this annotation is associated with. Example:
"Configuration for the PrinterService bundle".
-   * @return A human readable description of the PID this annotation is associated with (may
be localized)
+   * A human readable description of the PID this configuration is associated with. Example:
"Configuration for the PrinterService bundle".
+   * @return A human readable description of the PID this configuration is associated with
(may be localized)
    */
   ConfigurationDependency setDescription(String description);
 
   /**
    * Points to the basename of the Properties file that can localize the Meta Type informations.
-   * By default, (e.g. <code>setLocalization("person")</code> would match person_du_NL.properties
in the root bundle directory.
    * The default localization base name for the properties is OSGI-INF/l10n/bundle, but can
    * be overridden by the manifest Bundle-Localization header (see core specification, in
section Localization on page 68).
+   * You can specify a specific localization basename file using this method (e.g. <code>setLocalization("person")</code>

+   * will match person_du_NL.properties in the root bundle directory.
    */
   ConfigurationDependency setLocalization(String path);
 
   /**
-   * Add Configuration MetaData
+   * Adds a MetaData regarding a given configuration property.
    */
   ConfigurationDependency add(PropertyMetaData properties);
 }

Modified: felix/trunk/dependencymanager/core/src/main/java/org/apache/felix/dm/dependencies/PropertyMetaData.java
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/core/src/main/java/org/apache/felix/dm/dependencies/PropertyMetaData.java?rev=919881&r1=919880&r2=919881&view=diff
==============================================================================
--- felix/trunk/dependencymanager/core/src/main/java/org/apache/felix/dm/dependencies/PropertyMetaData.java
(original)
+++ felix/trunk/dependencymanager/core/src/main/java/org/apache/felix/dm/dependencies/PropertyMetaData.java
Sun Mar  7 00:03:26 2010
@@ -1,5 +1,19 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless
+ * required by applicable law or agreed to in writing, software distributed under the License
is
+ * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
express
+ * or implied. See the License for the specific language governing permissions and limitations
+ * under the License.
+ */
 package org.apache.felix.dm.dependencies;
 
+/**
+ * This interface defines meta data regarding a given configuration property.
+ */
 public interface PropertyMetaData
 {
     /**
@@ -15,7 +29,7 @@
     PropertyMetaData setId(String id);
 
     /**
-     * Return the property primitive type. If must be either one of the following types:<p>
+     * Returns the property primitive type. If must be either one of the following types:<p>
      * <ul>
      *    <li>String.class</li>
      *    <li>Long.class</li>
@@ -30,7 +44,7 @@
     PropertyMetaData setType(Class type);
 
     /**
-     * Return a default for this property. The object must be of the appropriate type as
defined by the cardinality and getType(). 
+     * Returns a default for this property. The object must be of the appropriate type as
defined by the cardinality and getType(). 
      * The return type is a list of String  objects that can be converted to the appropriate
type. The cardinality of the return 
      * array must follow the absolute cardinality of this type. E.g. if the cardinality =
0, the array must contain 1 element. 
      * If the cardinality is 1, it must contain 0 or 1 elements. If it is -5, it must contain
from 0 to max 5 elements. Note that 
@@ -41,7 +55,7 @@
     /**
      * Returns the property description. The description may be localized and must describe
the semantics of this type and any 
      * constraints. Example: "Select the log level for the Printer Service".
-     * @return The localized description of the definition.
+     * @return a localizable description of the property.
      */
     PropertyMetaData setDescription(String description);
 



Mime
View raw message