Browse Source

remove all javadoc references to the mythical JmeException

Stephen Gold 5 years ago
parent
commit
a124fcd284

+ 7 - 9
jme3-core/src/main/java/com/jme3/math/Matrix3f.java

@@ -146,13 +146,12 @@ public final class Matrix3f implements Savable, Cloneable, java.io.Serializable
     }
 
     /**
-     * <code>get</code> retrieves a value from the matrix at the given
-     * position. If the position is invalid a <code>JmeException</code> is
-     * thrown.
+     * <code>get</code> retrieves a value from the matrix at the given position.
      *
      * @param i   the row index.
-     * @param j   the colum index.
+     * @param j   the column index.
      * @return the value at (i, j).
+     * @throws IllegalArgumentException if either index is invalid
      */
     @SuppressWarnings("fallthrough")
     public float get(int i, int j) {
@@ -549,16 +548,16 @@ public final class Matrix3f implements Savable, Cloneable, java.io.Serializable
 
     /**
      * <code>set</code> places a given value into the matrix at the given
-     * position. If the position is invalid a <code>JmeException</code> is
-     * thrown.
+     * position.
      *
      * @param i
      *            the row index.
      * @param j
-     *            the colum index.
+     *            the column index.
      * @param value
      *            the value for (i, j).
      * @return this
+     * @throws IllegalArgumentException if either index is invalid
      */
     @SuppressWarnings("fallthrough")
     public Matrix3f set(int i, int j, float value) {
@@ -611,8 +610,7 @@ public final class Matrix3f implements Savable, Cloneable, java.io.Serializable
      *
      * @param matrix
      *            the new values of the matrix.
-     * @throws JmeException
-     *             if the array is not of size 9.
+     * @throws IllegalArgumentException if the matrix is not 3x3
      * @return this
      */
     public Matrix3f set(float[][] matrix) {

+ 17 - 15
jme3-core/src/main/java/com/jme3/math/Matrix4f.java

@@ -249,12 +249,13 @@ public final class Matrix4f implements Savable, Cloneable, java.io.Serializable
 
     /**
      * <code>get</code> retrieves a value from the matrix at the given
-     * position. If the position is invalid a <code>JmeException</code> is
-     * thrown.
+     * position.
      *
      * @param i   the row index.
-     * @param j   the colum index.
+     * @param j   the column index.
      * @return the value at (i, j).
+     * @throws IllegalArgumentException
+     *            if either index is invalid
      */
     @SuppressWarnings("fallthrough")
     public float get(int i, int j) {
@@ -413,13 +414,14 @@ public final class Matrix4f implements Savable, Cloneable, java.io.Serializable
 
     /**
      * <code>set</code> places a given value into the matrix at the given
-     * position. If the position is invalid a <code>JmeException</code> is
-     * thrown.
+     * position.
      *
      * @param i   the row index.
-     * @param j   the colum index.
+     * @param j   the column index.
      * @param value
      *            the value for (i, j).
+     * @throws IllegalArgumentException
+     *            if either index is invalid
      */
     @SuppressWarnings("fallthrough")
     public void set(int i, int j, float value) {
@@ -496,8 +498,8 @@ public final class Matrix4f implements Savable, Cloneable, java.io.Serializable
      *
      * @param matrix
      *            the matrix to set the value to.
-     * @throws JmeException
-     *             if the array is not of size 16.
+     * @throws IllegalArgumentException
+     *             if the array is 4x4
      */
     public void set(float[][] matrix) {
         if (matrix.length != 4 || matrix[0].length != 4) {
@@ -1808,7 +1810,7 @@ public final class Matrix4f implements Savable, Cloneable, java.io.Serializable
      *
      * @param translation
      *            the new values for the translation.
-     * @throws JmeException
+     * @throws IllegalArgumentException
      *             if translation is not size 3.
      */
     public void setTranslation(float[] translation) {
@@ -1852,7 +1854,7 @@ public final class Matrix4f implements Savable, Cloneable, java.io.Serializable
      *
      * @param translation
      *            the new values for the inverse translation.
-     * @throws JmeException
+     * @throws IllegalArgumentException
      *             if translation is not size 3.
      */
     public void setInverseTranslation(float[] translation) {
@@ -1922,7 +1924,7 @@ public final class Matrix4f implements Savable, Cloneable, java.io.Serializable
      *
      * @param angles
      *            the Euler angles in radians.
-     * @throws JmeException
+     * @throws IllegalArgumentException
      *             if angles is not size 3.
      */
     public void setInverseRotationRadians(float[] angles) {
@@ -1959,7 +1961,7 @@ public final class Matrix4f implements Savable, Cloneable, java.io.Serializable
      *
      * @param angles
      *            the Euler angles in degrees.
-     * @throws JmeException
+     * @throws IllegalArgumentException
      *             if angles is not size 3.
      */
     public void setInverseRotationDegrees(float[] angles) {
@@ -1980,7 +1982,7 @@ public final class Matrix4f implements Savable, Cloneable, java.io.Serializable
      *
      * @param vec
      *            the Vector3f data to be translated.
-     * @throws JmeException
+     * @throws IllegalArgumentException
      *             if the size of the Vector3f is not 3.
      */
     public void inverseTranslateVect(float[] vec) {
@@ -2000,7 +2002,7 @@ public final class Matrix4f implements Savable, Cloneable, java.io.Serializable
      *
      * @param data
      *            the Vector3f to be translated.
-     * @throws JmeException
+     * @throws IllegalArgumentException
      *             if the size of the Vector3f is not 3.
      */
     public void inverseTranslateVect(Vector3f data) {
@@ -2015,7 +2017,7 @@ public final class Matrix4f implements Savable, Cloneable, java.io.Serializable
      *
      * @param data
      *            the Vector3f to be translated.
-     * @throws JmeException
+     * @throws IllegalArgumentException
      *             if the size of the Vector3f is not 3.
      */
     public void translateVect(Vector3f data) {

+ 1 - 1
jme3-desktop/src/main/java/com/jme3/app/SettingsDialog.java

@@ -133,7 +133,7 @@ public final class SettingsDialog extends JFrame {
      *            the image file to use as the title of the dialog;
      *            <code>null</code> will result in to image being displayed
      * @param loadSettings 
-     * @throws JmeException
+     * @throws NullPointerException
      *             if the source is <code>null</code>
      */
     public SettingsDialog(AppSettings source, URL imageFile, boolean loadSettings) {

+ 3 - 6
jme3-terrain/src/main/java/com/jme3/terrain/heightmap/AbstractHeightMap.java

@@ -109,7 +109,7 @@ public abstract class AbstractHeightMap implements HeightMap {
      *            the new size of the terrain.
      * @throws Exception 
      *
-     * @throws JmeException
+     * @throws Exception
      *             if the size is less than or equal to zero.
      */
     public void setSize(int size) throws Exception {
@@ -127,8 +127,7 @@ public abstract class AbstractHeightMap implements HeightMap {
      *
      * @param filter
      *            the erosion value.
-     * @throws Exception 
-     * @throws JmeException
+     * @throws Exception
      *             if filter is less than 0 or greater than 1.
      */
     public void setMagnificationFilter(float filter) throws Exception {
@@ -243,9 +242,7 @@ public abstract class AbstractHeightMap implements HeightMap {
      * @param filename
      *            the file name to save the current data as.
      * @return true if the save was successful, false otherwise.
-     * @throws Exception 
-     *
-     * @throws JmeException
+     * @throws Exception
      *             if filename is null.
      */
     public boolean save(String filename) throws Exception {

+ 5 - 5
jme3-terrain/src/main/java/com/jme3/terrain/heightmap/CombinerHeightMap.java

@@ -74,7 +74,7 @@ public class CombinerHeightMap extends AbstractHeightMap {
      * @param map2 the second heightmap to combine.
      * @param mode denotes whether to add or subtract the heightmaps, may
      *              be either ADDITION or SUBTRACTION.
-     * @throws JmeException if either map is null, their size
+     * @throws Exception if either map is null, their size
      *              do not match or the mode is invalid.
      */
     public CombinerHeightMap(
@@ -122,7 +122,7 @@ public class CombinerHeightMap extends AbstractHeightMap {
      * @param factor2 the factor for map2.
      * @param mode denotes whether to add or subtract the heightmaps, may
      *              be either ADDITION or SUBTRACTION.
-     * @throws JmeException if either map is null, their size
+     * @throws Exception if either map is null, their size
      *              do not match, the mode is invalid, or the factors do not add
      *              to 1.0.
      */
@@ -173,7 +173,7 @@ public class CombinerHeightMap extends AbstractHeightMap {
      * to 1.0.
      * @param factor1 the factor for map1.
      * @param factor2 the factor for map2.
-     * @throws JmeException if the factors do not add to 1.0.
+     * @throws Exception if the factors do not add to 1.0.
      */
     public void setFactors(float factor1, float factor2) throws Exception {
         if ((factor1 + factor2) != 1.0f) {
@@ -190,7 +190,7 @@ public class CombinerHeightMap extends AbstractHeightMap {
      * The size of the height maps must be the same.
      * @param map1 the first height map.
      * @param map2 the second height map.
-     * @throws JmeException if the either heightmap is null, or their
+     * @throws Exception if the either heightmap is null, or their
      *              sizes do not match.
      */
     public void setHeightMaps(AbstractHeightMap map1, AbstractHeightMap map2) throws Exception {
@@ -213,7 +213,7 @@ public class CombinerHeightMap extends AbstractHeightMap {
      * <code>setMode</code> sets the mode of the combiner. This may either
      * be ADDITION or SUBTRACTION.
      * @param mode the mode of the combiner.
-     * @throws JmeException if mode is not ADDITION or SUBTRACTION.
+     * @throws Exception if mode is not ADDITION or SUBTRACTION.
      */
     public void setMode(int mode) throws Exception {
         if (mode != ADDITION && mode != SUBTRACTION) {

+ 3 - 3
jme3-terrain/src/main/java/com/jme3/terrain/heightmap/FluidSimHeightMap.java

@@ -81,7 +81,7 @@ public class FluidSimHeightMap extends AbstractHeightMap {
      *                        the distance between each node of the heightmap
      * @param seed
      *            the seed to generate the same heightmap again
-     * @throws JmeException
+     * @throws Exception
      *             if size of the terrain is not greater that zero, or number of
      *             iterations is not greater that zero, or the minimum initial height
      *             is greater than the maximum (or the other way around)
@@ -116,7 +116,7 @@ public class FluidSimHeightMap extends AbstractHeightMap {
      *            size the size of the terrain to be generated
      * @param iterations
      *            the number of iterations to do
-     * @throws JmeException
+     * @throws Exception
      *             if size of the terrain is not greater that zero, or number of
      *             iterations is not greater that zero
      */
@@ -232,7 +232,7 @@ public class FluidSimHeightMap extends AbstractHeightMap {
      *
      * @param iterations
      *            the number of iterations to do
-     * @throws JmeException
+     * @throws Exception
      *             if iterations if not greater than zero
      */
     public void setIterations(int iterations) throws Exception {

+ 1 - 4
jme3-terrain/src/main/java/com/jme3/terrain/heightmap/HeightMap.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2020 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -130,7 +130,6 @@ public interface HeightMap {
      * @param filter
      * the erosion value.
      * @throws Exception
-     * @throws JmeException
      * if filter is less than 0 or greater than 1.
      */
     void setMagnificationFilter(float filter) throws Exception;
@@ -142,8 +141,6 @@ public interface HeightMap {
      * @param size
      * the new size of the terrain.
      * @throws Exception
-     *
-     * @throws JmeException
      * if the size is less than or equal to zero.
      */
     void setSize(int size) throws Exception;

+ 1 - 6
jme3-terrain/src/main/java/com/jme3/terrain/heightmap/HillHeightMap.java

@@ -66,7 +66,6 @@ public class HillHeightMap extends AbstractHeightMap {
      * @param seed
      *            the seed to generate the same heightmap again
      * @throws Exception
-     * @throws JmeException
      *             if size of the terrain is not greater that zero, or number of
      *             iterations is not greater that zero
      */
@@ -104,7 +103,6 @@ public class HillHeightMap extends AbstractHeightMap {
      * @param maxRadius
      *            the maximum radius of a hill
      * @throws Exception
-     * @throws JmeException
      *             if size of the terrain is not greater that zero, or number of
      *             iterations is not greater that zero
      */
@@ -213,7 +211,6 @@ public class HillHeightMap extends AbstractHeightMap {
      * @param iterations
      *            the number of hills to grow
      * @throws Exception
-     * @throws JmeException
      *             if iterations if not greater than zero
      */
     public void setIterations(int iterations) throws Exception {
@@ -230,7 +227,6 @@ public class HillHeightMap extends AbstractHeightMap {
      * @param maxRadius
      *            the maximum radius of a hill
      * @throws Exception
-     * @throws JmeException
      *             if the maximum radius if not greater than zero or not greater
      *             than the minimum radius
      */
@@ -247,8 +243,7 @@ public class HillHeightMap extends AbstractHeightMap {
      *
      * @param minRadius
      *            the minimum radius of a hill
-     * @throws Exception
-     * @throws JmeException if the minimum radius is not greater than zero or not
+     * @throws Exception if the minimum radius is not greater than zero or not
      *        lower than the maximum radius
      */
     public void setMinRadius(float minRadius) throws Exception {

+ 6 - 6
jme3-terrain/src/main/java/com/jme3/terrain/heightmap/ParticleDepositionHeightMap.java

@@ -76,7 +76,7 @@ public class ParticleDepositionHeightMap extends AbstractHeightMap {
      *              represented as a percentage, where 0.0 will not invert
      *              anything, and 1.0 will invert all.
      *
-     * @throws JmeException if any value is less than zero, and
+     * @throws Exception if any value is less than zero, and
      *              if caldera is not between 0 and 1. If minParticles is greater than
      *              max particles as well.
      */
@@ -328,7 +328,7 @@ public class ParticleDepositionHeightMap extends AbstractHeightMap {
      * <code>setJumps</code> sets the number of jumps or peaks that will
      * be created during the next call to <code>load</code>.
      * @param jumps the number of jumps to use for next load.
-     * @throws JmeException if jumps is less than zero.
+     * @throws Exception if jumps is less than zero.
      */
     public void setJumps(int jumps) throws Exception {
         if (jumps < 0) {
@@ -343,7 +343,7 @@ public class ParticleDepositionHeightMap extends AbstractHeightMap {
      * be aggitated.
      *
      * @param peakWalk the amount to aggitate the jump point.
-     * @throws JmeException if peakWalk is negative or zero.
+     * @throws Exception if peakWalk is negative or zero.
      */
     public void setPeakWalk(int peakWalk) throws Exception {
         if (peakWalk <= 0) {
@@ -359,7 +359,7 @@ public class ParticleDepositionHeightMap extends AbstractHeightMap {
      *
      * @param caldera the level at which a peak will be inverted. This must be
      *              between 0 and 1, as it is represented as a percentage.
-     * @throws JmeException if caldera is not between 0 and 1.
+     * @throws Exception if caldera is not between 0 and 1.
      */
     public void setCaldera(float caldera) throws Exception {
         if (caldera < 0.0f || caldera > 1.0f) {
@@ -373,7 +373,7 @@ public class ParticleDepositionHeightMap extends AbstractHeightMap {
      * <code>setMaxParticles</code> sets the maximum number of particles
      * for a single jump.
      * @param maxParticles the maximum number of particles for a single jump.
-     * @throws JmeException if maxParticles is negative or less than
+     * @throws Exception if maxParticles is negative or less than
      *              the current number of minParticles.
      */
     public void setMaxParticles(int maxParticles) {
@@ -384,7 +384,7 @@ public class ParticleDepositionHeightMap extends AbstractHeightMap {
      * <code>setMinParticles</code> sets the minimum number of particles
      * for a single jump.
      * @param minParticles the minimum number of particles for a single jump.
-     * @throws JmeException if minParticles are greater than
+     * @throws Exception if minParticles are greater than
      *              the current maxParticles;
      */
     public void setMinParticles(int minParticles) throws Exception {

+ 6 - 6
jme3-terrain/src/main/java/com/jme3/terrain/heightmap/RawHeightMap.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2012 jMonkeyEngine
+ * Copyright (c) 2009-2020 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -74,7 +74,7 @@ public class RawHeightMap extends AbstractHeightMap {
      *            the RAW file to use as the heightmap.
      * @param size
      *            the size of the RAW (must be square).
-     * @throws JmeException
+     * @throws Exception
      *             if the filename is null or not RAW, and if the size is 0 or
      *             less.
      */
@@ -137,10 +137,10 @@ public class RawHeightMap extends AbstractHeightMap {
 
     /**
      * <code>load</code> fills the height data array with the appropriate data
-     * from the set RAW image. If the RAW image has not been set a JmeException
-     * will be thrown.
+     * from the set RAW image.
      *
      * @return true if the load is successfull, false otherwise.
+     * @throws RuntimeException if the RAW image has not been set
      */
     @Override
     public boolean load() {
@@ -216,7 +216,7 @@ public class RawHeightMap extends AbstractHeightMap {
      *
      * @param filename
      *            the new file to use for the height data.
-     * @throws JmeException
+     * @throws Exception
      *             if the file is null or not RAW.
      */
     public void setFilename(String filename) throws Exception {
@@ -236,7 +236,7 @@ public class RawHeightMap extends AbstractHeightMap {
      *
      * @param stream
      *            the new stream to use for the height data.
-     * @throws JmeException
+     * @throws Exception
      *             if the stream is null or not RAW.
      */
     public void setHeightStream(InputStream stream) throws Exception {