source code formatting.

[utils] / system / general / src / main / java / org / wamblee / system / graph / component / ConnectRequiredExternallyRequiredEdgeFilter.java

diff --git a/system/general/src/main/java/org/wamblee/system/graph/component/ConnectRequiredExternallyRequiredEdgeFilter.java b/system/general/src/main/java/org/wamblee/system/graph/component/ConnectRequiredExternallyRequiredEdgeFilter.java
index 4c5404b9f0c8fe321fae6b2a054e9caafe911602..b59618d8d4d1ecd63679ff6233bcbb33797630b5 100644 (file)
--- a/system/general/src/main/java/org/wamblee/system/graph/component/ConnectRequiredExternallyRequiredEdgeFilter.java
+++ b/system/general/src/main/java/org/wamblee/system/graph/component/ConnectRequiredExternallyRequiredEdgeFilter.java
@@ -1,12 +1,12 @@
 /*
  * 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.
@@ -18,57 +18,99 @@ package org.wamblee.system.graph.component;
 import org.wamblee.system.graph.Edge;
 import org.wamblee.system.graph.EdgeFilter;
 
+
 /**
- * Filter used to explicitly connect required and provided interfaces within a
- * container.
- * 
+ * Filter used to explicitly connect required and provided interfaces
+ * within a container.
+ *
  * @author Erik Brakkee
- * 
  */
 public class ConnectRequiredExternallyRequiredEdgeFilter implements EdgeFilter {
-
+    /**
+     * DOCUMENT ME!
+     */
     private String client;
+
+    /**
+     * DOCUMENT ME!
+     */
     private String required;
+
+    /**
+     * DOCUMENT ME!
+     */
     private String externalRequired;
 
-    public ConnectRequiredExternallyRequiredEdgeFilter(String aClient, String aRequired,
-            String aExternalRequired) {
-        client = aClient;
-        required = aRequired;
-        externalRequired = aExternalRequired; 
-        if ( client == null ) { 
-            throw new IllegalArgumentException("Client component must be specified"); 
+    /**
+     * Creates a new ConnectRequiredExternallyRequiredEdgeFilter object.
+     *
+     * @param aClient DOCUMENT ME!
+     * @param aRequired DOCUMENT ME!
+     * @param aExternalRequired DOCUMENT ME!
+     */
+    public ConnectRequiredExternallyRequiredEdgeFilter(String aClient,
+        String aRequired, String aExternalRequired) {
+        client               = aClient;
+        required             = aRequired;
+        externalRequired     = aExternalRequired;
+
+        if (client == null) {
+            throw new IllegalArgumentException(
+                "Client component must be specified");
         }
-        if ( required == null ) { 
-            throw new IllegalArgumentException("Required interface must be specified");
+
+        if (required == null) {
+            throw new IllegalArgumentException(
+                "Required interface must be specified");
         }
-        if ( externalRequired == null ) { 
-            throw new IllegalArgumentException("External required interface must be specified");
+
+        if (externalRequired == null) {
+            throw new IllegalArgumentException(
+                "External required interface must be specified");
         }
     }
 
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aEdge DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     @Override
     public boolean isViolated(Edge aEdge) {
         if (aEdge.getFrom() instanceof RequiredInterfaceNode
                 && aEdge.getTo() instanceof ExternalRequiredInterfaceNode) {
             return isViolated((RequiredInterfaceNode) aEdge.getFrom(),
-                    (ExternalRequiredInterfaceNode) aEdge.getTo());
+                (ExternalRequiredInterfaceNode) aEdge.getTo());
         }
+
         return false;
     }
 
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aFrom DOCUMENT ME!
+     * @param aTo DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     private boolean isViolated(RequiredInterfaceNode aFrom,
-            ExternalRequiredInterfaceNode aTo) {
-        if ( !aFrom.getComponent().getName().equals(client)) { 
+        ExternalRequiredInterfaceNode aTo) {
+        if (!aFrom.getComponent().getName().equals(client)) {
             return false; // wrong component. 
         }
-        if ( !(required == null || aFrom.getRequired().getName().equals(required))) { 
+
+        if (!((required == null)
+                || aFrom.getRequired().getName().equals(required))) {
             return false; // wrong interface
         }
-        if ( !aTo.getRequired().getName().equals(externalRequired)) { 
+
+        if (!aTo.getRequired().getName().equals(externalRequired)) {
             return true; // wrong externally required interface.  
         }
-      
-        return false; 
+
+        return false;
     }
 }