Revision 3

Author: emeijering

pom.xml

@@ -10,7 +10,7 @@
 	</parent>
 
 	<artifactId>imagescience</artifactId>
-	<version>2.4.3-SNAPSHOT</version>
+	<version>3.0.0</version>
 
 	<name>jars/imagescience.jar</name>
 	<description />

src/main/java/imagescience/ImageScience.java

@@ -0,0 +1,38 @@
+package imagescience;
+
+/** Contains the name and version number of the ImageScience library. */
+public class ImageScience {
+	
+	/** Default constructor. */
+	public ImageScience() { }
+	
+	/** Returns the name of the library.
+		
+		@return A new {@code String} object with the name of the library.
+	*/
+	public static String name() {
+		
+		return "ImageScience";
+	}
+	
+	/** Returns the version number of the library.
+		
+		@return A new {@code String} object with the version number of the library.
+	*/
+	public static String version() {
+		
+		final String version = ImageScience.class.getPackage().getImplementationVersion();
+		
+		return (version == null) ? "DEV" : version;
+	}
+	
+	/** Returns the name and version number of the library appended with a colon and space.
+		
+		@return A new {@code String} object with the name and version number of the library appended with a colon and space.
+	*/
+	public static String prelude() {
+		
+		return name()+" "+version()+": ";
+	}
+	
+}

src/main/java/imagescience/array/ByteArray.java

@@ -1,4 +1,5 @@
 package imagescience.color;
+
 import java.awt.Color;
 
 /** A palette of 100 different colors. */
@@ -54,16 +55,16 @@ public class Palette {
 
 	private final int mode;
 
-	private int nextindex;
+	private int next;
 
 	/** Default constructor. Results in a palette operating in the arbitrary mode. */
 	public Palette() { this(ARBITRARY); }
 
 	/** Mode constructor. Results in a palette operating in the given mode.
 		
-		@param mode the palette mode. Must be one of the static fields of this class.
+		@param mode The palette mode. Must be one of the static fields of this class.
 		
-		@exception IllegalArgumentException if {@code mode} is not one of the static fields of this class.
+		@throws IllegalArgumentException If {@code mode} is not one of the static fields of this class.
 	*/
 	public Palette(final int mode) {
 
@@ -85,13 +86,15 @@ public Palette(final int mode) {
 
 	/** Returns the palette mode.
 		
-		@return the palette mode. The returned value is equal to one of the static fields of this class.
+		@return The palette mode. The returned value is equal to one of the static fields of this class.
 	*/
 	public int mode() { return mode; }
 
 	/** Returns the color at the given index (modulo 100).
 		
-		@return the color at the given index (modulo 100). The actual color returned depends on the mode of the palette.
+		@param index The index.
+		
+		@return The color at the given index (modulo 100). The actual color returned depends on the mode of the palette.
 	*/
 	public Color get(final int index) {
 
@@ -100,9 +103,9 @@ public Color get(final int index) {
 
 	/** Returns the index of the given color.
 		
-		@param color the color whose index is to be returned.
+		@param color The color.
 		
-		@return the index of the given color. The actual index returned depends on the mode of the palette. If {@code color} is {@code null} or it is not in the palette, the method returns -1.
+		@return The index of the given color. The actual index returned depends on the mode of the palette. If {@code color} is {@code null} or it is not in the palette, the method returns -1.
 	*/
 	public int index(final Color color) {
 
@@ -118,22 +121,22 @@ public int index(final Color color) {
 
 	/** Returns the next color. Calling this method repeatedly yields a sequence of colors with a period of 100 colors. Colors that have been marked explicitly as used will first be skipped until all colors have been used and a new cycle is started.
 		
-		@return the next color. The actual color returned depends on the mode of the palette.
+		@return The next color. The actual color returned depends on the mode of the palette.
 	*/
 	public Color next() {
 
 		while (true) {
-			if (nextindex == SIZE) { reset(); break; }
-			else if (!used[nextindex]) break;
-			else ++nextindex;
+			if (next == SIZE) { reset(); break; }
+			else if (!used[next]) break;
+			else ++next;
 		}
-		used[nextindex] = true;
-		return colors[nextindex++];
+		used[next] = true;
+		return colors[next++];
 	}
 
 	/** Marks the given color as used if it is in the palette. Colors that have been marked as used will first be skipped by the {@link #next()} method until all colors have been used and a new cycle is started.
 		
-		@param color the color to be marked as used.
+		@param color The color.
 	*/
 	public void used(final Color color) {
 
@@ -149,7 +152,7 @@ public void used(final Color color) {
 	public void reset() {
 
 		for (int i=0; i<SIZE; ++i) used[i] = false;
-		nextindex = 0;
+		next = 0;
 	}
 
 }

src/main/java/imagescience/array/DoubleArray.java

@@ -10,18 +10,18 @@ public Wave2Color() { }
 
 	/** Converts a wavelength to its corresponding RGBA color values.
 		
-		@param wavelen the wavelength (in nanometers) to be converted.
+		@param wavelen The wavelength (in nanometers) to be converted.
 		
-		@param rgba the {@code double} array in which the RGBA values will be stored:<br>
+		@param rgba The {@code double} array in which the RGBA values will be stored:<br>
 		{@code [0]} = the value of the red (R) component,<br>
 		{@code [1]} = the value of the green (G) component,<br>
 		{@code [2]} = the value of the blue (B) component,<br>
 		{@code [3]} = the value of the alpha (A) component.<br>
 		The value of each component is in the range {@code [0.0,1.0]}.
 		
-		@exception NullPointerException if {@code rgba} is {@code null}.
+		@throws NullPointerException If {@code rgba} is {@code null}.
 		
-		@exception ArrayIndexOutOfBoundsException if the length of {@code rgba} is not {@code 4}.
+		@throws ArrayIndexOutOfBoundsException If the length of {@code rgba} is not {@code 4}.
 	*/
 	public void rgba(final double wavelen, final double[] rgba) {
 
@@ -71,9 +71,9 @@ public void rgba(final double wavelen, final double[] rgba) {
 
 	/** Converts a wavelength to its corresponding RGBA color values.
 		
-		@param wavelen the wavelength (in nanometers) to be converted.
+		@param wavelen The wavelength (in nanometers) to be converted.
 		
-		@return a new {@code double} array with four elements:<br>
+		@return A new {@code double} array with four elements:<br>
 		{@code [0]} = the value of the red (R) component,<br>
 		{@code [1]} = the value of the green (G) component,<br>
 		{@code [2]} = the value of the blue (B) component,<br>
@@ -89,9 +89,9 @@ public double[] rgba(final double wavelen) {
 
 	/** Converts a wavelength to its corresponding RGBA color values.
 		
-		@param wavelen the wavelength (in nanometers) to be converted.
+		@param wavelen The wavelength (in nanometers) to be converted.
 		
-		@return a new {@code Color} object containing the RGBA color values.
+		@return A new {@code Color} object containing the RGBA color values.
 	*/
 	public Color color(final double wavelen) {