X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=system%2Fgeneral%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fsystem%2Fcomponents%2FPropertyComponent.java;h=718432fcbb93b98a95d8d98aee763e8a5d68c835;hb=ddd261f331280640c5b53c7128230b629ebcd268;hp=48ef0e38eb991910cd01b4711f820eb8b0e17016;hpb=92e23e5ecf9614f2ab770a8cdedc0b21ddf1e127;p=utils

diff --git a/system/general/src/main/java/org/wamblee/system/components/PropertyComponent.java b/system/general/src/main/java/org/wamblee/system/components/PropertyComponent.java
index 48ef0e38..718432fc 100644
--- a/system/general/src/main/java/org/wamblee/system/components/PropertyComponent.java
+++ b/system/general/src/main/java/org/wamblee/system/components/PropertyComponent.java
@@ -1,70 +1,116 @@
 /*
  * Copyright 2008 the original author or authors.
- * 
+ *
  * Licensed 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.wamblee.system.components;
 
-import java.io.IOException;
-import java.util.Properties;
-
 import org.wamblee.io.InputResource;
+
 import org.wamblee.system.core.AbstractComponent;
 import org.wamblee.system.core.DefaultProvidedInterface;
 import org.wamblee.system.core.ProvidedInterface;
 import org.wamblee.system.core.Scope;
 
+import java.io.IOException;
+
+import java.util.Properties;
+
+
 /**
- * Property component that reads a property file and provides
- * it to other components through a provided interface.
- * 
- * NOTE: when multiple property components are used, disambiguation
- * of provided and required interfaces is needed. 
- *  
+ * Property component that reads a property file and provides it to other
+ * components through a provided interface.  NOTE: when multiple property
+ * components are used, disambiguation of provided and required interfaces is
+ * needed.
+ *
  * @author Erik Brakkee
  */
 public class PropertyComponent extends AbstractComponent<Properties> {
-    
-    private static ProvidedInterface PROPS = new DefaultProvidedInterface("props", Properties.class);
-    
+    /**
+     * DOCUMENT ME!
+     */
+    private static ProvidedInterface PROPS = new DefaultProvidedInterface("props",
+            Properties.class);
+
+    /**
+     * DOCUMENT ME!
+     */
     private Properties props;
-    
-    public PropertyComponent(String aName, InputResource aResource) throws IOException { 
-        this(aName, readProps(aResource)); 
-    }
-    
-    private static Properties readProps(InputResource aResource) throws IOException {
-        Properties props = new Properties(); 
-        props.load(aResource.getInputStream());
-        return props; 
+
+    /**
+     * Creates a new PropertyComponent object.
+     *
+     * @param aName DOCUMENT ME!
+     * @param aResource DOCUMENT ME!
+     *
+     * @throws IOException DOCUMENT ME!
+     */
+    public PropertyComponent(String aName, InputResource aResource)
+        throws IOException {
+        this(aName, readProps(aResource));
     }
 
+    /**
+     * Creates a new PropertyComponent object.
+     *
+     * @param aName DOCUMENT ME!
+     * @param aProps DOCUMENT ME!
+     */
     public PropertyComponent(String aName, Properties aProps) {
         super(aName);
-        props = aProps; 
-        
+        props = aProps;
+
         addProvidedInterface(PROPS);
     }
 
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aResource DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     *
+     * @throws IOException DOCUMENT ME!
+     */
+    private static Properties readProps(InputResource aResource)
+        throws IOException {
+        Properties props = new Properties();
+        props.load(aResource.getInputStream());
+
+        return props;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aScope DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     @Override
     protected Properties doStart(Scope aScope) {
         addInterface(PROPS, props, aScope);
-        return props; 
+
+        return props;
     }
 
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aRuntime DOCUMENT ME!
+     */
     @Override
     protected void doStop(Properties aRuntime) {
         // Empty 
     }
-
 }