Refine Int -> Enum conversion (commit 40863632d1428de015099b5967e5136425e99f25), throw IllegalArgumentException if ordinal is out-of-range. Add API doc.

- FFMPEGNatives
- MouseEvent.PointerType

2 files changed, 59 insertions, 16 deletions

diff --git a/src/jogl/classes/jogamp/opengl/util/av/impl/FFMPEGNatives.java b/src/jogl/classes/jogamp/opengl/util/av/impl/FFMPEGNatives.java
index 89c15b905..8e08c23fa 100644
--- a/src/jogl/classes/jogamp/opengl/util/av/impl/FFMPEGNatives.java
+++ b/src/jogl/classes/jogamp/opengl/util/av/impl/FFMPEGNatives.java
@@ -92,13 +92,22 @@ interface FFMPEGNatives {
         
         COUNT;       ///< Number of sample formats.
         
-        public static SampleFormat valueOf(int i) {
-            // ordinal = enumValue.ordinal(), reverse: enumValue = EnumClass.values()[ordinal]
+        /** 
+         * Returns the matching SampleFormat value corresponding to the given SampleFormat's integer ordinal.
+         * <pre>
+         *   given:
+         *     ordinal = enumValue.ordinal()
+         *   reverse:
+         *     enumValue = EnumClass.values()[ordinal]
+         * </pre>
+         * @throws IllegalArgumentException if the given ordinal is out of range, i.e. not within [ 0 .. SampleFormat.values().length-1 ]
+         */
+        public static SampleFormat valueOf(int ordinal) throws IllegalArgumentException {
             final SampleFormat[] all = SampleFormat.values();
-            if( 0 <= i && i < all.length ) {
-                return all[i];
+            if( 0 <= ordinal && ordinal < all.length ) {
+                return all[ordinal];
             }
-            return null;            
+            throw new IllegalArgumentException("Ordinal "+ordinal+" out of range of SampleFormat.values()[0.."+(all.length-1)+"]");
         }
     };
 
@@ -246,13 +255,22 @@ interface FFMPEGNatives {
         GBRP16LE,  ///< planar GBR 4:4:4 48bpp, little endian
         COUNT      ///< number of pixel formats in this list
         ;
-        public static PixelFormat valueOf(int i) {
-            // ordinal = enumValue.ordinal(), reverse: enumValue = EnumClass.values()[ordinal]
+        /** 
+         * Returns the matching PixelFormat value corresponding to the given PixelFormat's integer ordinal.
+         * <pre>
+         *   given:
+         *     ordinal = enumValue.ordinal()
+         *   reverse:
+         *     enumValue = EnumClass.values()[ordinal]
+         * </pre>
+         * @throws IllegalArgumentException if the given ordinal is out of range, i.e. not within [ 0 .. PixelFormat.values().length-1 ]
+         */
+        public static PixelFormat valueOf(int ordinal) throws IllegalArgumentException {
             final PixelFormat[] all = PixelFormat.values();
-            if( 0 <= i && i < all.length ) {
-                return all[i];
+            if( 0 <= ordinal && ordinal < all.length ) {
+                return all[ordinal];
             }
-            return null;            
+            throw new IllegalArgumentException("Ordinal "+ordinal+" out of range of PixelFormat.values()[0.."+(all.length-1)+"]");
         }
     }
-}
+}
\ No newline at end of file
diff --git a/src/newt/classes/com/jogamp/newt/event/MouseEvent.java b/src/newt/classes/com/jogamp/newt/event/MouseEvent.java
index cb9e7a290..85c65b39c 100644
--- a/src/newt/classes/com/jogamp/newt/event/MouseEvent.java
+++ b/src/newt/classes/com/jogamp/newt/event/MouseEvent.java
@@ -79,13 +79,38 @@ public class MouseEvent extends InputEvent
         
         public PointerClass getPointerClass() { return pc; }
         
-        public static PointerType valueOf(int i) {
-            // ordinal = enumValue.ordinal(), reverse: enumValue = EnumClass.values()[ordinal]
+        /** 
+         * Returns the matching PointerType value corresponding to the given PointerType's integer ordinal.
+         * <pre>
+         *   given:
+         *     ordinal = enumValue.ordinal()
+         *   reverse:
+         *     enumValue = EnumClass.values()[ordinal]
+         * </pre>
+         * @throws IllegalArgumentException if the given ordinal is out of range, i.e. not within [ 0 .. PointerType.values().length-1 ]
+         */
+        public static PointerType valueOf(int ordinal) throws IllegalArgumentException {
             final PointerType[] all = PointerType.values();
-            if( 0 <= i && i < all.length ) {
-                return all[i];
+            if( 0 <= ordinal && ordinal < all.length ) {
+                return all[ordinal];
             }
-            return null;            
+            throw new IllegalArgumentException("Ordinal "+ordinal+" out of range of PointerType.values()[0.."+(all.length-1)+"]");
+        }
+        
+        /** 
+         * Returns the PointerType array of matching PointerType values corresponding to the given PointerType's integer ordinal values.
+         * <p>
+         * See {@link #valueOf(int)}.
+         * </p>
+         * @throws IllegalArgumentException if one of the given ordinal values is out of range, i.e. not within [ 0 .. PointerType.values().length-1 ]
+         */
+        public static PointerType[] valuesOf(int[] ordinals) throws IllegalArgumentException {
+            final int count = ordinals.length;
+            final PointerType[] types = new PointerType[count];
+            for(int i=count-1; i>=0; i--) {
+                types[i] = PointerType.valueOf(ordinals[i]);
+            }
+            return types;
         }
         
         private PointerType(PointerClass pc) {