source code formatting.
[utils] / system / general / src / main / java / org / wamblee / system / graph / component / RequiredInterfaceNode.java
index 1b053b1891d3d723ecc879ff23982733b2e7674f..9b50eb9c4a57eaaff7e6542447c5ac0443adab14 100644 (file)
@@ -1,49 +1,88 @@
 /*
  * 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;
 
+
+/**
+ * Required interface node.
+ *
+ * @author Erik Brakkee
+ */
 public class RequiredInterfaceNode implements Node {
-    
-    private Component _component; 
-    private RequiredInterface _required; 
-    
-    public RequiredInterfaceNode(Component aComponent, RequiredInterface aRequired) {
-        _component = aComponent; 
-        _required = aRequired; 
+    /**
+     * DOCUMENT ME!
+     */
+    private Component component;
+
+    /**
+     * DOCUMENT ME!
+     */
+    private RequiredInterface required;
+
+    /**
+     * Creates a new RequiredInterfaceNode object.
+     *
+     * @param aComponent DOCUMENT ME!
+     * @param aRequired DOCUMENT ME!
+     */
+    public RequiredInterfaceNode(Component aComponent,
+        RequiredInterface aRequired) {
+        component     = aComponent;
+        required      = aRequired;
     }
 
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     @Override
     public String getName() {
-        return _component.getQualifiedName() + ":" + _required.getName();
+        return component.getQualifiedName() + ":" + required.getName();
     }
 
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     public RequiredInterface getRequired() {
-        return _required;
+        return required;
     }
-    
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     public Component getComponent() {
-        return _component;
+        return component;
     }
-    
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     @Override
     public String toString() {
-        return _component.getQualifiedName() + ":" + _required; 
+        return component.getQualifiedName() + ":" + required;
     }
 }