source code formatting.
[utils] / system / general / src / main / java / org / wamblee / system / graph / component / ExternalRequiredInterfaceNode.java
index 6b71ffeaf31ef710469e224ed16c76bbcbbcaec0..59fcb4034af8d72af6b0e339a01a1ea25e694662 100644 (file)
@@ -1,52 +1,86 @@
 /*
  * 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.graph.component;
 
 import org.wamblee.system.core.Component;
 import org.wamblee.system.core.RequiredInterface;
 import org.wamblee.system.graph.Node;
 
+
 /**
- * Represents an externally required interface of a container. 
- * @author Erik Brakkee
+ * Represents an externally required interface of a container.
  *
+ * @author Erik Brakkee
  */
 public class ExternalRequiredInterfaceNode implements Node {
-    
+    /**
+     * DOCUMENT ME!
+     */
     private Component component;
-    private RequiredInterface required; 
 
-    public ExternalRequiredInterfaceNode(Component aComponent, RequiredInterface aRequired) {
-        component = aComponent; 
-        required = aRequired; 
+    /**
+     * DOCUMENT ME!
+     */
+    private RequiredInterface required;
+
+    /**
+     * Creates a new ExternalRequiredInterfaceNode object.
+     *
+     * @param aComponent DOCUMENT ME!
+     * @param aRequired DOCUMENT ME!
+     */
+    public ExternalRequiredInterfaceNode(Component aComponent,
+        RequiredInterface aRequired) {
+        component     = aComponent;
+        required      = aRequired;
     }
-    
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     @Override
     public String getName() {
-        return required.getName(); 
+        return required.getName();
     }
-    
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     public Component getComponent() {
         return component;
     }
-    
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     public RequiredInterface getRequired() {
         return required;
     }
-    
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     @Override
     public String toString() {
         return component.getQualifiedName() + ":" + required;