Added Override annotations, finals, some cleanup and better null checks (#1271)

* Added Override annotations, finals, some cleanup and better null checks

* More general null check

* Follow naming conventions

jme3-niftygui/src/main/java/com/jme3/cinematic/events/GuiEvent.java

@@ -37,6 +37,7 @@ import com.jme3.export.JmeExporter;
 import com.jme3.export.JmeImporter;
 import com.jme3.export.OutputCapsule;
 import de.lessvoid.nifty.Nifty;
+import de.lessvoid.nifty.screen.Screen;
 import java.io.IOException;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -51,7 +52,7 @@ public class GuiEvent extends AbstractCinematicEvent {
     /**
      * message logger for this class
      */
-    static final Logger log = Logger.getLogger(GuiEvent.class.getName());
+    private static final Logger log = Logger.getLogger(GuiEvent.class.getName());
 
     /**
      * name of the associated Nifty screen(not null)
@@ -135,8 +136,9 @@ public class GuiEvent extends AbstractCinematicEvent {
      */
     @Override
     public void onStop() {
-        if (nifty.getCurrentScreen() != null) {
+        Screen currentScreen = nifty.getCurrentScreen();
-            nifty.getCurrentScreen().endScreen(null);
+        if (currentScreen != null) {
+            currentScreen.endScreen(null);
         }
     }
 

jme3-niftygui/src/main/java/com/jme3/cinematic/events/GuiTrack.java

@@ -37,6 +37,7 @@ import com.jme3.export.JmeExporter;
 import com.jme3.export.JmeImporter;
 import com.jme3.export.OutputCapsule;
 import de.lessvoid.nifty.Nifty;
+import de.lessvoid.nifty.screen.Screen;
 import java.io.IOException;
 
 /**
@@ -84,8 +85,9 @@ public class GuiTrack extends AbstractCinematicEvent {
 
     @Override
     public void onStop() {
-        if (nifty.getCurrentScreen() != null) {
+        Screen currentScreen = nifty.getCurrentScreen();
-            nifty.getCurrentScreen().endScreen(null);
+        if (currentScreen != null) {
+            currentScreen.endScreen(null);
         }
     }
 

jme3-niftygui/src/main/java/com/jme3/niftygui/InputSystemJme.java

@@ -46,14 +46,15 @@ import de.lessvoid.nifty.input.keyboard.KeyboardInputEvent;
 import de.lessvoid.nifty.spi.input.InputSystem;
 import de.lessvoid.nifty.tools.resourceloader.NiftyResourceLoader;
 import java.util.ArrayList;
+import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
 public class InputSystemJme implements InputSystem, RawInputListener {
 
-    private final ArrayList<InputEvent> inputQueue = new ArrayList<InputEvent>();
+    private final List<InputEvent> inputQueue = new ArrayList<>();
-    private InputManager inputManager;
+    private final InputManager inputManager;
-    private boolean[] niftyOwnsDragging = new boolean[3];
+    private final boolean[] niftyOwnsDragging = new boolean[3];
     private int inputPointerId = -1;
     private int x, y;
     private int height;
@@ -65,6 +66,7 @@ public class InputSystemJme implements InputSystem, RawInputListener {
         this.inputManager = inputManager;
     }
 
+    @Override
     public void setResourceLoader(NiftyResourceLoader niftyResourceLoader) {
     }
 
@@ -101,15 +103,18 @@ public class InputSystemJme implements InputSystem, RawInputListener {
         this.height = height;
     }
 
+    @Override
     public void setMousePosition(int x, int y) {
         // TODO: When does nifty use this?
     }
 
+    @Override
     public void beginInput() {
     }
 
+    @Override
     public void endInput() {
-        boolean result = nifty.update();
+        nifty.update();
     }
 
     private void handleMouseEvent(int button, boolean value, NiftyInputConsumer nic, InputEvent evt) {
@@ -251,6 +256,7 @@ public class InputSystemJme implements InputSystem, RawInputListener {
         }
     }
 
+    @Override
     public void onMouseMotionEvent(MouseMotionEvent evt) {
         // Only forward the event if there's actual motion involved.
         if (inputManager.isCursorVisible() && (evt.getDX() != 0
@@ -260,6 +266,7 @@ public class InputSystemJme implements InputSystem, RawInputListener {
         }
     }
 
+    @Override
     public void onMouseButtonEvent(MouseButtonEvent evt) {
         if (evt.getButtonIndex() >= 0 && evt.getButtonIndex() <= 2) {
             if (evt.isReleased() || inputManager.isCursorVisible()) {
@@ -270,20 +277,25 @@ public class InputSystemJme implements InputSystem, RawInputListener {
         }
     }
 
+    @Override
     public void onJoyAxisEvent(JoyAxisEvent evt) {
     }
 
+    @Override
     public void onJoyButtonEvent(JoyButtonEvent evt) {
     }
 
+    @Override
     public void onKeyEvent(KeyInputEvent evt) {
         inputQueue.add(evt);
     }
 
+    @Override
     public void onTouchEvent(TouchEvent evt) {
         inputQueue.add(evt);
     }
 
+    @Override
     public void forwardEvents(NiftyInputConsumer nic) {
         int queueSize = inputQueue.size();
 
@@ -317,6 +329,8 @@ public class InputSystemJme implements InputSystem, RawInputListener {
                     }
 
                     softTextDialogInput.requestDialog(SoftTextDialogInput.TEXT_ENTRY_DIALOG, "Enter Text", initialValue, new SoftTextDialogInputListener() {
+
+                        @Override
                         public void onSoftText(int action, String text) {
                             if (action == SoftTextDialogInputListener.COMPLETE) {
                                 textField.setText(text);

jme3-niftygui/src/main/java/com/jme3/niftygui/NiftyJmeDisplay.java

@@ -31,9 +31,6 @@
  */
 package com.jme3.niftygui;
 
-import java.io.InputStream;
-import java.net.URL;
-
 import com.jme3.asset.AssetInfo;
 import com.jme3.asset.AssetKey;
 import com.jme3.asset.AssetManager;
@@ -48,12 +45,13 @@ import com.jme3.renderer.Renderer;
 import com.jme3.renderer.ViewPort;
 import com.jme3.renderer.queue.RenderQueue;
 import com.jme3.texture.FrameBuffer;
-
 import de.lessvoid.nifty.Nifty;
 import de.lessvoid.nifty.render.batch.BatchRenderConfiguration;
 import de.lessvoid.nifty.render.batch.BatchRenderDevice;
 import de.lessvoid.nifty.spi.time.impl.AccurateTimeProvider;
 import de.lessvoid.nifty.tools.resourceloader.ResourceLocation;
+import java.io.InputStream;
+import java.net.URL;
 
 public class NiftyJmeDisplay implements SceneProcessor {
 
@@ -76,8 +74,9 @@ public class NiftyJmeDisplay implements SceneProcessor {
 
     protected class ResourceLocationJme implements ResourceLocation {
 
+        @Override
         public InputStream getResourceAsStream(String path) {
-            AssetKey<Object> key = new AssetKey<Object>(path);
+            AssetKey<Object> key = new AssetKey<>(path);
             AssetInfo info = assetManager.locateAsset(key);
             if (info != null) {
                 return info.openStream();
@@ -86,6 +85,7 @@ public class NiftyJmeDisplay implements SceneProcessor {
             }
         }
 
+        @Override
         public URL getResource(String path) {
             throw new UnsupportedOperationException();
         }
@@ -112,6 +112,7 @@ public class NiftyJmeDisplay implements SceneProcessor {
      * @param inputManager jME InputManager
      * @param audioRenderer jME AudioRenderer
      * @param viewport Viewport to use
+     * @return new NiftyJmeDisplay instance
      */
     public static NiftyJmeDisplay newNiftyJmeDisplay(
         final AssetManager assetManager,
@@ -142,6 +143,7 @@ public class NiftyJmeDisplay implements SceneProcessor {
      *        you can use to further configure batch rendering. If unsure you
      *        can simply use new BatchRenderConfiguration() in here for the
      *        default configuration which should give you good default values.
+     * @return new NiftyJmeDisplay instance
      */
     public static NiftyJmeDisplay newNiftyJmeDisplay(
         final AssetManager assetManager,
@@ -280,6 +282,7 @@ public class NiftyJmeDisplay implements SceneProcessor {
       this.inputSys = new InputSystemJme(inputManager);
     }
 
+    @Override
     public void initialize(RenderManager rm, ViewPort vp) {
         this.renderManager = rm;
         if (renderDev != null) {
@@ -328,6 +331,7 @@ public class NiftyJmeDisplay implements SceneProcessor {
         return renderer;
     }
 
+    @Override
     public void reshape(ViewPort vp, int w, int h) {
         this.w = w;
         this.h = h;
@@ -335,13 +339,16 @@ public class NiftyJmeDisplay implements SceneProcessor {
         nifty.resolutionChanged();
     }
 
+    @Override
     public boolean isInitialized() {
         return inited;
     }
 
+    @Override
     public void preFrame(float tpf) {
     }
 
+    @Override
     public void postQueue(RenderQueue rq) {
         // render nifty before anything else
         renderManager.setCamera(vp.getCamera(), true);
@@ -350,9 +357,11 @@ public class NiftyJmeDisplay implements SceneProcessor {
         renderManager.setCamera(vp.getCamera(), false);
     }
 
+    @Override
     public void postFrame(FrameBuffer out) {
     }
 
+    @Override
     public void cleanup() {
         inited = false;
         inputSys.reset();

jme3-niftygui/src/main/java/com/jme3/niftygui/RenderDeviceJme.java

@@ -57,27 +57,28 @@ import de.lessvoid.nifty.tools.resourceloader.NiftyResourceLoader;
 import java.nio.ByteBuffer;
 import java.nio.FloatBuffer;
 import java.util.HashMap;
+import java.util.Map;
 
 public class RenderDeviceJme implements RenderDevice {
 
-    private NiftyJmeDisplay display;
+    private final NiftyJmeDisplay display;
     private RenderManager rm;
     private Renderer r;
-    private HashMap<CachedTextKey, BitmapText> textCacheLastFrame = new HashMap<CachedTextKey, BitmapText>();
+    private Map<CachedTextKey, BitmapText> textCacheLastFrame = new HashMap<>();
-    private HashMap<CachedTextKey, BitmapText> textCacheCurrentFrame = new HashMap<CachedTextKey, BitmapText>();
+    private Map<CachedTextKey, BitmapText> textCacheCurrentFrame = new HashMap<>();
     private final Quad quad = new Quad(1, -1, true);
     private final Geometry quadGeom = new Geometry("nifty-quad", quad);
     private boolean clipWasSet = false;
-    private VertexBuffer quadDefaultTC = quad.getBuffer(Type.TexCoord);
+    private final VertexBuffer quadDefaultTC = quad.getBuffer(Type.TexCoord);
-    private VertexBuffer quadModTC = quadDefaultTC.clone();
+    private final VertexBuffer quadModTC = quadDefaultTC.clone();
-    private VertexBuffer quadColor;
+    private final VertexBuffer quadColor;
-    private Matrix4f tempMat = new Matrix4f();
+    private final Matrix4f tempMat = new Matrix4f();
-    private ColorRGBA tempColor = new ColorRGBA();
+    private final ColorRGBA tempColor = new ColorRGBA();
-    private RenderState renderState = new RenderState();
+    private final RenderState renderState = new RenderState();
 
-    private Material colorMaterial;
+    private final Material colorMaterial;
-    private Material textureColorMaterial;
+    private final Material textureColorMaterial;
-    private Material vertexColorMaterial;
+    private final Material vertexColorMaterial;
 
     private static class CachedTextKey {
 
@@ -138,6 +139,7 @@ public class RenderDeviceJme implements RenderDevice {
         renderState.setDepthWrite(false);
     }
 
+    @Override
     public void setResourceLoader(NiftyResourceLoader niftyResourceLoader) {
     }
 
@@ -147,8 +149,11 @@ public class RenderDeviceJme implements RenderDevice {
     }
 
     // TODO: Cursor support
+    @Override
     public MouseCursor createMouseCursor(String str, int x, int y) {
         return new MouseCursor() {
+
+            @Override
             public void dispose() {
             }
 
@@ -162,43 +167,53 @@ public class RenderDeviceJme implements RenderDevice {
         };
     }
 
+    @Override
     public void enableMouseCursor(MouseCursor cursor) {
     }
 
+    @Override
     public void disableMouseCursor() {
     }
 
+    @Override
     public RenderImage createImage(String filename, boolean linear) {
         //System.out.println("createImage(" + filename + ", " + linear + ")");
         return new RenderImageJme(filename, linear, display);
     }
 
+    @Override
     public RenderFont createFont(String filename) {
         return new RenderFontJme(filename, display);
     }
 
+    @Override
     public void beginFrame() {
     }
 
+    @Override
     public void endFrame() {
-        HashMap<CachedTextKey, BitmapText> temp = textCacheLastFrame;
+        Map<CachedTextKey, BitmapText> temp = textCacheLastFrame;
         textCacheLastFrame = textCacheCurrentFrame;
         textCacheCurrentFrame = temp;
         textCacheCurrentFrame.clear();
         rm.setForcedRenderState(null);
     }
 
+    @Override
     public int getWidth() {
         return display.getWidth();
     }
 
+    @Override
     public int getHeight() {
         return display.getHeight();
     }
 
+    @Override
     public void clear() {
     }
 
+    @Override
     public void setBlendMode(BlendMode blendMode) {
         renderState.setBlendMode(convertBlend(blendMode));
     }
@@ -206,12 +221,14 @@ public class RenderDeviceJme implements RenderDevice {
     private RenderState.BlendMode convertBlend(BlendMode blendMode) {
         if (blendMode == null) {
             return RenderState.BlendMode.Off;
-        } else if (blendMode == BlendMode.BLEND) {
+        } else
-            return RenderState.BlendMode.Alpha;
+            switch (blendMode) {
-        } else if (blendMode == BlendMode.MULIPLY) {
+                case BLEND:
-            return RenderState.BlendMode.Alpha;
+                    return RenderState.BlendMode.Alpha;
-        } else {
+                case MULIPLY:
-            throw new UnsupportedOperationException();
+                    return RenderState.BlendMode.Alpha;
+                default:
+                    throw new UnsupportedOperationException();
         }
     }
 
@@ -264,6 +281,7 @@ public class RenderDeviceJme implements RenderDevice {
 //        System.out.format("renderFont(%s, %s, %d, %d, %s, %f, %f)\n", jmeFont.getFont(), str, x, y, color.toString(), sizeX, sizeY);
     }
 
+    @Override
     public void renderImage(RenderImage image, int x, int y, int w, int h,
             int srcX, int srcY, int srcW, int srcH,
             Color color, float scale,
@@ -314,6 +332,7 @@ public class RenderDeviceJme implements RenderDevice {
         //                                                                                       color.toString(), scale, centerX, centerY);
     }
 
+    @Override
     public void renderImage(RenderImage image, int x, int y, int width, int height,
             Color color, float imageScale) {
 
@@ -339,6 +358,7 @@ public class RenderDeviceJme implements RenderDevice {
         //System.out.format("renderImage1(%s, %d, %d, %d, %d, %s, %f)\n", jmeImage.getTexture().getKey().toString(), x, y, width, height, color.toString(), imageScale);
     }
 
+    @Override
     public void renderQuad(int x, int y, int width, int height, Color color) {
         //We test for alpha >0 as an optimization to prevent the render of completely transparent quads.
         //Nifty use layers that are often used for logical positionning and not rendering.
@@ -360,6 +380,7 @@ public class RenderDeviceJme implements RenderDevice {
         //System.out.format("renderQuad1(%d, %d, %d, %d, %s)\n", x, y, width, height, color.toString());
     }
 
+    @Override
     public void renderQuad(int x, int y, int width, int height,
             Color topLeft, Color topRight, Color bottomRight, Color bottomLeft) {
 
@@ -389,11 +410,13 @@ public class RenderDeviceJme implements RenderDevice {
         //                                                                                        bottomLeft.toString());
     }
 
+    @Override
     public void enableClip(int x0, int y0, int x1, int y1) {
         clipWasSet = true;
         r.setClipRect(x0, getHeight() - y1, x1 - x0, y1 - y0);
     }
 
+    @Override
     public void disableClip() {
         if (clipWasSet) {
             r.clearClipRect();

jme3-niftygui/src/main/java/com/jme3/niftygui/RenderFontJme.java

@@ -37,17 +37,16 @@ import de.lessvoid.nifty.spi.render.RenderFont;
 
 public class RenderFontJme implements RenderFont {
 
-    private NiftyJmeDisplay display;
+    private final BitmapFont font;
-    private BitmapFont font;
+    private final BitmapText text;
-    private BitmapText text;
+    private final float actualSize;
-    private float actualSize;
 
     /**
      * Initialize the font.
      * @param name font filename
+     * @param display
      */
     public RenderFontJme(String name, NiftyJmeDisplay display) {
-        this.display = display;
         font = display.getAssetManager().loadFont(name);
         text = new BitmapText(font);
         actualSize = font.getPreferredSize();
@@ -70,6 +69,7 @@ public class RenderFontJme implements RenderFont {
      * get font height.
      * @return height
      */
+    @Override
     public int getHeight() {
         return (int) text.getLineHeight();
     }
@@ -79,6 +79,7 @@ public class RenderFontJme implements RenderFont {
      * @param str text
      * @return width of the given text for the current font
      */
+    @Override
     public int getWidth(final String str) {
         if (str.length() == 0) {
             return 0;
@@ -98,6 +99,7 @@ public class RenderFontJme implements RenderFont {
         return result;
     }
 
+    @Override
     public int getWidth(final String str, final float size) {
       // Note: This is supposed to return the width of the String when scaled
       //       with the size factor. Since I don't know how to do that with
@@ -113,10 +115,12 @@ public class RenderFontJme implements RenderFont {
      * @param size font size
      * @return width of the character or null when no information for the character is available
      */
+    @Override
     public int getCharacterAdvance(final char currentCharacter, final char nextCharacter, final float size) {
         return Math.round(font.getCharacterAdvance(currentCharacter, nextCharacter, size));
     }
 
+    @Override
     public void dispose() {
     }
 }

jme3-niftygui/src/main/java/com/jme3/niftygui/RenderImageJme.java

@@ -75,14 +75,17 @@ public class RenderImageJme implements RenderImage {
         return texture;
     }
 
+    @Override
     public int getWidth() {
         return width;
     }
 
+    @Override
     public int getHeight() {
         return height;
     }
 
+    @Override
     public void dispose() {
     }
 }

jme3-niftygui/src/main/java/com/jme3/niftygui/SoundDeviceJme.java

@@ -50,19 +50,23 @@ public class SoundDeviceJme implements SoundDevice {
         this.ar = ar;
     }
 
+    @Override
     public void setResourceLoader(NiftyResourceLoader niftyResourceLoader) {
     }
 
+    @Override
     public SoundHandle loadSound(SoundSystem soundSystem, String filename) {
         AudioNode an = new AudioNode(assetManager, filename, AudioData.DataType.Buffer);
         an.setPositional(false);
         return new SoundHandleJme(ar, an);
     }
 
+    @Override
     public SoundHandle loadMusic(SoundSystem soundSystem, String filename) {
         return new SoundHandleJme(ar, assetManager, filename);
     }
 
+    @Override
     public void update(int delta) {
     }
 

jme3-niftygui/src/main/java/com/jme3/niftygui/SoundHandleJme.java

@@ -34,8 +34,8 @@ package com.jme3.niftygui;
 import com.jme3.asset.AssetManager;
 import com.jme3.audio.AudioData;
 import com.jme3.audio.AudioNode;
-import com.jme3.audio.AudioSource.Status;
 import com.jme3.audio.AudioRenderer;
+import com.jme3.audio.AudioSource.Status;
 import de.lessvoid.nifty.spi.sound.SoundHandle;
 
 public class SoundHandleJme implements SoundHandle {
@@ -72,6 +72,7 @@ public class SoundHandleJme implements SoundHandle {
         this.fileName = fileName;
     }
 
+    @Override
     public void play() {
         if (fileName != null){
             if (node != null){
@@ -87,6 +88,7 @@ public class SoundHandleJme implements SoundHandle {
         }
     }
 
+    @Override
     public void stop() {
         if (node != null){
             node.stop();
@@ -98,6 +100,7 @@ public class SoundHandleJme implements SoundHandle {
         }
     }
 
+    @Override
     public void setVolume(float f) {
         if (node != null) {
             node.setVolume(f);
@@ -105,14 +108,17 @@ public class SoundHandleJme implements SoundHandle {
         volume = f;
     }
 
+    @Override
     public float getVolume() {
         return volume;
     }
 
+    @Override
     public boolean isPlaying() {
         return node != null && node.getStatus() == Status.Playing;
     }
 
+    @Override
     public void dispose() {
     }
 }