Commits

Michael Ludwig committed 801ee1f

Minor refactorings in documentation, exception names, and make Surface.destroy() return a Future.

Comments (0)

Files changed (5)

ferox-renderer/ferox-renderer-api/src/main/java/com/ferox/renderer/Framework.java

      * @param resource The Resource whose status message is requested
      * @return The status message for resource
      * @throws NullPointerException if resource is null
-     * @throws RenderException if the Framework has been destroyed
+     * @throws FrameworkException if the Framework has been destroyed
      */
     public String getStatusMessage(Resource resource);
 

ferox-renderer/ferox-renderer-api/src/main/java/com/ferox/renderer/FrameworkException.java

+package com.ferox.renderer;
+
+/**
+ * A RuntimeException that is used by the renderer package for exceptions that
+ * are better described by custom exceptions, instead of the basic java.lang
+ * ones.
+ * 
+ * @author Michael Ludwig
+ */
+public class FrameworkException extends RuntimeException {
+    private static final long serialVersionUID = 1L;
+
+    public FrameworkException() {
+        super();
+    }
+
+    public FrameworkException(String arg0) {
+        super(arg0);
+    }
+
+    public FrameworkException(Throwable arg0) {
+        super(arg0);
+    }
+
+    public FrameworkException(String arg0, Throwable arg1) {
+        super(arg0, arg1);
+    }
+}

ferox-renderer/ferox-renderer-api/src/main/java/com/ferox/renderer/RenderException.java

-package com.ferox.renderer;
-
-/**
- * A RuntimeException that is used by the renderer package for exceptions that
- * are better described by custom exceptions, instead of the basic java.lang
- * ones.
- * 
- * @author Michael Ludwig
- */
-public class RenderException extends RuntimeException {
-    private static final long serialVersionUID = 1L;
-
-    public RenderException() {
-        super();
-    }
-
-    public RenderException(String arg0) {
-        super(arg0);
-    }
-
-    public RenderException(Throwable arg0) {
-        super(arg0);
-    }
-
-    public RenderException(String arg0, Throwable arg1) {
-        super(arg0, arg1);
-    }
-}

ferox-renderer/ferox-renderer-api/src/main/java/com/ferox/renderer/Surface.java

 package com.ferox.renderer;
 
+import java.util.concurrent.Future;
+
 
 /**
  * <p>
      * low-level graphics layer and hiding any onscreen elements, such as a
      * window. Destroying an already destroyed surface does nothing.
      */
-    public void destroy();
+    public Future<Void> destroy();
 
     /**
      * Return the width of the actual drawable area of the surface (doesn't

ferox-renderer/ferox-renderer-api/src/main/java/com/ferox/renderer/SurfaceCreationException.java

  * 
  * @author Michael Ludwig
  */
-public class SurfaceCreationException extends RenderException {
+public class SurfaceCreationException extends FrameworkException {
     private static final long serialVersionUID = 1L;
 
     public SurfaceCreationException() {