source code formatting.
[utils] / system / general / src / main / java / org / wamblee / system / graph / component / ConnectExternalProvidedProvidedFilter.java
index 578bc72f4d4b3c232668c83a005d7d9db446f082..01c316a0c161e847c015a2bd0d0ab919503c75dd 100644 (file)
@@ -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,54 +18,95 @@ 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 ConnectExternalProvidedProvidedFilter implements EdgeFilter {
-
+    /**
+     * DOCUMENT ME!
+     */
     private String externalProvided;
+
+    /**
+     * DOCUMENT ME!
+     */
     private String component;
+
+    /**
+     * DOCUMENT ME!
+     */
     private String provided;
 
-    public ConnectExternalProvidedProvidedFilter(String aExternalProvided, String aComponent,
-            String aProvided) {
-        externalProvided = aExternalProvided; 
-        component = aComponent; 
-        provided = aProvided; 
-        if ( externalProvided == null ) { 
-            throw new IllegalArgumentException("External provided interface name must be specified."); 
+    /**
+     * Creates a new ConnectExternalProvidedProvidedFilter object.
+     *
+     * @param aExternalProvided DOCUMENT ME!
+     * @param aComponent DOCUMENT ME!
+     * @param aProvided DOCUMENT ME!
+     */
+    public ConnectExternalProvidedProvidedFilter(String aExternalProvided,
+        String aComponent, String aProvided) {
+        externalProvided     = aExternalProvided;
+        component            = aComponent;
+        provided             = aProvided;
+
+        if (externalProvided == null) {
+            throw new IllegalArgumentException(
+                "External provided interface name must be specified.");
         }
-        if ( component == null ) { 
-            throw new IllegalArgumentException("Component name must be specified");
+
+        if (component == null) {
+            throw new IllegalArgumentException(
+                "Component name must be specified");
         }
-        if ( provided == null ) { 
-            throw new IllegalArgumentException("Provided interface name of internal component must be specified");
+
+        if (provided == null) {
+            throw new IllegalArgumentException(
+                "Provided interface name of internal component must be specified");
         }
     }
 
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aEdge DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     @Override
     public boolean isViolated(Edge aEdge) {
         if (aEdge.getFrom() instanceof ExternalProvidedInterfaceNode
                 && aEdge.getTo() instanceof ProvidedInterfaceNode) {
             return isViolated((ExternalProvidedInterfaceNode) aEdge.getFrom(),
-                    (ProvidedInterfaceNode) aEdge.getTo());
+                (ProvidedInterfaceNode) aEdge.getTo());
         }
+
         return false;
     }
 
+    /**
+     * DOCUMENT ME!
+     *
+     * @param aFrom DOCUMENT ME!
+     * @param aTo DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
     private boolean isViolated(ExternalProvidedInterfaceNode aFrom,
-            ProvidedInterfaceNode aTo) {
-        if ( !aFrom.getName().equals(externalProvided)) { 
+        ProvidedInterfaceNode aTo) {
+        if (!aFrom.getName().equals(externalProvided)) {
             return false; // wrong provided interface.
         }
-        if ( aTo.getComponent().getName().equals(component) && 
-               aTo.getProvided().getName().equals(provided) ) { 
+
+        if (aTo.getComponent().getName().equals(component)
+                && aTo.getProvided().getName().equals(provided)) {
             return false; // ok 
         }
-        return true; 
+
+        return true;
     }
 }