Xcos: add some javadoc comments and JDK8 style
[scilab.git] / scilab / modules / xcos / src / java / org / scilab / modules / xcos / block / BasicBlock.java
index 627eb8c..efaebd7 100644 (file)
@@ -122,7 +122,7 @@ public class BasicBlock extends XcosCell implements Serializable {
      *            the cell
      * @return the base index
      */
-    private static final int compareByChildClass(final Object o1, final Object o2) {
+    private static int compareByChildClass(final Object o1, final Object o2) {
         int o1Index = 0;
         int o2Index = 0;
 
@@ -172,7 +172,7 @@ public class BasicBlock extends XcosCell implements Serializable {
         MODELICA(30004), /** Magic types */
         UNKNOWN(5);
 
-        private int value;
+        private final int value;
 
         /**
          * Default constructor
@@ -211,7 +211,16 @@ public class BasicBlock extends XcosCell implements Serializable {
     };
 
     /**
-     * Default constructor.
+     * Constructor that setup some properties and pass all its arguments this its {@link XcosCell} parent.
+     *
+     *
+     * @param controller The shared controller instance
+     * @param uid the uid of the MVC object
+     * @param kind {@link Kind#BLOCK} or {@link Kind#ANNOTATION}
+     * @param value the value of the block
+     * @param geometry the geometry to apply to this JGraphX object
+     * @param style the style to apply to this JGraphX object
+     * @param id the id to apply to this JGraphX object
      */
     public BasicBlock(final JavaController controller, long uid, Kind kind, Object value, mxGeometry geometry, String style, String id) {
         super(controller, uid, kind, value, geometry, style, id);
@@ -241,10 +250,9 @@ public class BasicBlock extends XcosCell implements Serializable {
 
     /**
      * Does the block update and register on the undo manager
-     * @param controller
-     *
-     * @param modifiedBlock
-     *            the new settings
+     * @param controller the shared controller
+     * @param parent the parent diagram or superblock diagram
+     * @param modifiedBlock the new settings
      */
     public void updateBlockSettings(JavaController controller, XcosDiagram parent, BasicBlock modifiedBlock) {
         if (modifiedBlock == null) {
@@ -336,10 +344,10 @@ public class BasicBlock extends XcosCell implements Serializable {
         controller.getObjectProperty(modifiedBlock.getUID(), modifiedBlock.getKind(), ObjectProperties.DIAGRAM_CONTEXT, vStr);
         controller.setObjectProperty(getUID(), getKind(), ObjectProperties.DIAGRAM_CONTEXT, vStr);
 
-        VectorOfScicosID children = new VectorOfScicosID();
+        VectorOfScicosID localChildren = new VectorOfScicosID();
 
-        controller.getObjectProperty(modifiedBlock.getUID(), modifiedBlock.getKind(), ObjectProperties.CHILDREN, children);
-        controller.setObjectProperty(getUID(), getKind(), ObjectProperties.CHILDREN, children);
+        controller.getObjectProperty(modifiedBlock.getUID(), modifiedBlock.getKind(), ObjectProperties.CHILDREN, localChildren);
+        controller.setObjectProperty(getUID(), getKind(), ObjectProperties.CHILDREN, localChildren);
 
         /*
          * JGraphX mapped properties
@@ -362,7 +370,7 @@ public class BasicBlock extends XcosCell implements Serializable {
         /*
          * Checked as port classes only
          */
-        Set < Class <? extends mxICell >> types = new HashSet < Class <? extends mxICell >> (Arrays.asList(InputPort.class, OutputPort.class, ControlPort.class, CommandPort.class));
+        Set < Class <? extends mxICell >> types = new HashSet < > (Arrays.asList(InputPort.class, OutputPort.class, ControlPort.class, CommandPort.class));
 
         Map < Class <? extends mxICell > , Deque<mxICell >> annotatedOlds = getTypedChildren(types);
         Map < Class <? extends mxICell > , Deque<mxICell >> annotatedNews = modifiedBlock.getTypedChildren(types);
@@ -382,10 +390,10 @@ public class BasicBlock extends XcosCell implements Serializable {
 
                     // relink
                     if (previous.getEdgeCount() != 0) {
-                        final mxICell edge = previous.getEdgeAt(0);
-                        final boolean isOutgoing = previous == edge.getTerminal(true);
-                        previous.removeEdge(edge, isOutgoing);
-                        modified.insertEdge(edge, isOutgoing);
+                        final mxICell relinked = previous.getEdgeAt(0);
+                        final boolean isOutgoing = previous == relinked.getTerminal(true);
+                        previous.removeEdge(relinked, isOutgoing);
+                        modified.insertEdge(relinked, isOutgoing);
                     }
 
                     parent.removeCells(new Object[] { previous }, false);
@@ -419,11 +427,11 @@ public class BasicBlock extends XcosCell implements Serializable {
      * @return a map which linked foreach type the corresponding cell list.
      */
     private Map < Class <? extends mxICell > , Deque<mxICell >> getTypedChildren(Set < Class <? extends mxICell >> types) {
-        Map < Class <? extends mxICell > , Deque<mxICell >> oldPorts = new HashMap < Class <? extends mxICell > , Deque<mxICell >> ();
+        Map < Class <? extends mxICell > , Deque<mxICell >> oldPorts = new HashMap < > ();
 
         // Allocate all types set
         for (Class <? extends mxICell > type : types) {
-            oldPorts.put(type, new LinkedList<mxICell>());
+            oldPorts.put(type, new LinkedList<>());
         }
 
         if (getChildCount() <= 0) {
@@ -685,7 +693,7 @@ public class BasicBlock extends XcosCell implements Serializable {
     // CSOFF: JavaNCSS
     public ContextMenu createContextMenu(ScilabGraph graph) {
         ContextMenu menu = ScilabContextMenu.createContextMenu();
-        Map<Class<? extends DefaultAction>, Menu> menuList = new HashMap<Class<? extends DefaultAction>, Menu>();
+        Map<Class<? extends DefaultAction>, Menu> menuList = new HashMap<>();
 
         MenuItem value = BlockParametersAction.createMenu(graph);
         menuList.put(BlockParametersAction.class, value);