/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package java.awt;

import java.beans.ConstructorProperties;

import java.awt.image.ColorModel;

import java.awt.geom.AffineTransform;

import java.awt.geom.Rectangle2D;

import java.awt.color.ColorSpace;

/**

 * The <code>Color</code> class is used to encapsulate colors in the default

 * sRGB color space or colors in arbitrary color spaces identified by a

 * {@link ColorSpace}.  Every color has an implicit alpha value of 1.0 or

 * an explicit one provided in the constructor.  The alpha value

 * defines the transparency of a color and can be represented by

 * a float value in the range 0.0 - 1.0 or 0 - 255.

 * An alpha value of 1.0 or 255 means that the color is completely

 * opaque and an alpha value of 0 or 0.0 means that the color is

 * completely transparent.

 * When constructing a <code>Color</code> with an explicit alpha or

 * getting the color/alpha components of a <code>Color</code>, the color

 * components are never premultiplied by the alpha component.

 * <p>

 * The default color space for the Java 2D(tm) API is sRGB, a proposed

 * standard RGB color space.  For further information on sRGB,

 * see <A href="http://www.w3.org/pub/WWW/Graphics/Color/sRGB.html">

 * http://www.w3.org/pub/WWW/Graphics/Color/sRGB.html

 * </A>.

 * <p>

 * @version     10 Feb 1997

 * @author      Sami Shaio

 * @author      Arthur van Hoff

 * @see         ColorSpace

 * @see         AlphaComposite

 */

public class Color implements Paint, java.io.Serializable {

    /**

     * The color white.  In the default sRGB space.

     */

    public final static Color white     = new Color(255, 255, 255);

    /**

     * The color white.  In the default sRGB space.

     * @since 1.4

     */

    public final static Color WHITE = white;

    /**

     * The color light gray.  In the default sRGB space.

     */

    public final static Color lightGray = new Color(192, 192, 192);

    /**

     * The color light gray.  In the default sRGB space.

     * @since 1.4

     */

    public final static Color LIGHT_GRAY = lightGray;

    /**

     * The color gray.  In the default sRGB space.

     */

    public final static Color gray      = new Color(128, 128, 128);

    /**

     * The color gray.  In the default sRGB space.

     * @since 1.4

     */

    public final static Color GRAY = gray;

    /**

     * The color dark gray.  In the default sRGB space.

     */

    public final static Color darkGray  = new Color(64, 64, 64);

    /**

     * The color dark gray.  In the default sRGB space.

     * @since 1.4

     */

    public final static Color DARK_GRAY = darkGray;

    /**

     * The color black.  In the default sRGB space.

     */

    public final static Color black     = new Color(0, 0, 0);

    /**

     * The color black.  In the default sRGB space.

     * @since 1.4

     */

    public final static Color BLACK = black;

    /**

     * The color red.  In the default sRGB space.

     */

    public final static Color red       = new Color(255, 0, 0);

    /**

     * The color red.  In the default sRGB space.

     * @since 1.4

     */

    public final static Color RED = red;

    /**

     * The color pink.  In the default sRGB space.

     */

    public final static Color pink      = new Color(255, 175, 175);

    /**

     * The color pink.  In the default sRGB space.

     * @since 1.4

     */

    public final static Color PINK = pink;

    /**

     * The color orange.  In the default sRGB space.

     */

    public final static Color orange    = new Color(255, 200, 0);

    /**

     * The color orange.  In the default sRGB space.

     * @since 1.4

     */

    public final static Color ORANGE = orange;

    /**

     * The color yellow.  In the default sRGB space.

     */

    public final static Color yellow    = new Color(255, 255, 0);

    /**

     * The color yellow.  In the default sRGB space.

     * @since 1.4

     */

    public final static Color YELLOW = yellow;

    /**

     * The color green.  In the default sRGB space.

     */

    public final static Color green     = new Color(0, 255, 0);

    /**

     * The color green.  In the default sRGB space.

     * @since 1.4

     */

    public final static Color GREEN = green;

    /**

     * The color magenta.  In the default sRGB space.

     */

    public final static Color magenta   = new Color(255, 0, 255);

    /**

     * The color magenta.  In the default sRGB space.

     * @since 1.4

     */

    public final static Color MAGENTA = magenta;

    /**

     * The color cyan.  In the default sRGB space.

     */

    public final static Color cyan      = new Color(0, 255, 255);

    /**

     * The color cyan.  In the default sRGB space.

     * @since 1.4

     */

    public final static Color CYAN = cyan;

    /**

     * The color blue.  In the default sRGB space.

     */

    public final static Color blue      = new Color(0, 0, 255);

    /**

     * The color blue.  In the default sRGB space.

     * @since 1.4

     */

    public final static Color BLUE = blue;

    /**

     * The color value.

     * @serial

     * @see #getRGB

     */

    int value;

    /**

     * The color value in the default sRGB <code>ColorSpace</code> as

     * <code>float</code> components (no alpha).

     * If <code>null</code> after object construction, this must be an

     * sRGB color constructed with 8-bit precision, so compute from the

     * <code>int</code> color value.

     * @serial

     * @see #getRGBColorComponents

     * @see #getRGBComponents

     */

    private float frgbvalue[] = null;

    /**

     * The color value in the native <code>ColorSpace</code> as

     * <code>float</code> components (no alpha).

     * If <code>null</code> after object construction, this must be an

     * sRGB color constructed with 8-bit precision, so compute from the

     * <code>int</code> color value.

     * @serial

     * @see #getRGBColorComponents

     * @see #getRGBComponents

     */

    private float fvalue[] = null;

    /**

     * The alpha value as a <code>float</code> component.

     * If <code>frgbvalue</code> is <code>null</code>, this is not valid

     * data, so compute from the <code>int</code> color value.

     * @serial

     * @see #getRGBComponents

     * @see #getComponents

     */

    private float falpha = 0.0f;

    /**

     * The <code>ColorSpace</code>.  If <code>null</code>, then it's

     * default is sRGB.

     * @serial

     * @see #getColor

     * @see #getColorSpace

     * @see #getColorComponents

     */

    private ColorSpace cs = null;

    /*

     * JDK 1.1 serialVersionUID

     */

     private static final long serialVersionUID = 118526816881161077L;

    /**

     * Initialize JNI field and method IDs

     */

    private static native void initIDs();

    static {

        /** 4112352 - Calling getDefaultToolkit()

         ** here can cause this class to be accessed before it is fully

         ** initialized. DON'T DO IT!!!

         **

         ** Toolkit.getDefaultToolkit();

         **/

        /* ensure that the necessary native libraries are loaded */

        Toolkit.loadLibraries();

        if (!GraphicsEnvironment.isHeadless()) {

            initIDs();

        }

    }

    /**

     * Checks the color integer components supplied for validity.

     * Throws an {@link IllegalArgumentException} if the value is out of

     * range.

     * @param r the Red component

     * @param g the Green component

     * @param b the Blue component

     **/

    private static void testColorValueRange(int r, int g, int b, int a) {

        boolean rangeError = false;

        String badComponentString = "";

        if ( a < 0 || a > 255) {

            rangeError = true;

            badComponentString = badComponentString + " Alpha";

        }

        if ( r < 0 || r > 255) {

            rangeError = true;

            badComponentString = badComponentString + " Red";

        }

        if ( g < 0 || g > 255) {

            rangeError = true;

            badComponentString = badComponentString + " Green";

        }

        if ( b < 0 || b > 255) {

            rangeError = true;

            badComponentString = badComponentString + " Blue";

        }

        if ( rangeError == true ) {

        throw new IllegalArgumentException("Color parameter outside of expected range:"

                                           + badComponentString);

        }

    }

    /**

     * Checks the color <code>float</code> components supplied for

     * validity.

     * Throws an <code>IllegalArgumentException</code> if the value is out

     * of range.

     * @param r the Red component

     * @param g the Green component

     * @param b the Blue component

     **/

    private static void testColorValueRange(float r, float g, float b, float a) {

        boolean rangeError = false;

        String badComponentString = "";

        if ( a < 0.0 || a > 1.0) {

            rangeError = true;

            badComponentString = badComponentString + " Alpha";

        }

        if ( r < 0.0 || r > 1.0) {

            rangeError = true;

            badComponentString = badComponentString + " Red";

        }

        if ( g < 0.0 || g > 1.0) {

            rangeError = true;

            badComponentString = badComponentString + " Green";

        }

        if ( b < 0.0 || b > 1.0) {

            rangeError = true;

            badComponentString = badComponentString + " Blue";

        }

        if ( rangeError == true ) {

        throw new IllegalArgumentException("Color parameter outside of expected range:"

                                           + badComponentString);

        }

    }

    /**

     * Creates an opaque sRGB color with the specified red, green,

     * and blue values in the range (0 - 255).

     * The actual color used in rendering depends

     * on finding the best match given the color space

     * available for a given output device.

     * Alpha is defaulted to 255.

     *

     * @throws IllegalArgumentException if <code>r</code>, <code>g</code>

     *        or <code>b</code> are outside of the range

     *        0 to 255, inclusive

     * @param r the red component

     * @param g the green component

     * @param b the blue component

     * @see #getRed

     * @see #getGreen

     * @see #getBlue

     * @see #getRGB

     */

    public Color(int r, int g, int b) {

        this(r, g, b, 255);

    }

    /**

     * Creates an sRGB color with the specified red, green, blue, and alpha

     * values in the range (0 - 255).

     *

     * @throws IllegalArgumentException if <code>r</code>, <code>g</code>,

     *        <code>b</code> or <code>a</code> are outside of the range

     *        0 to 255, inclusive

     * @param r the red component

     * @param g the green component

     * @param b the blue component

     * @param a the alpha component

     * @see #getRed

     * @see #getGreen

     * @see #getBlue

     * @see #getAlpha

     * @see #getRGB

     */

    @ConstructorProperties({"red", "green", "blue", "alpha"})

    public Color(int r, int g, int b, int a) {

        value = ((a & 0xFF) << 24) |

                ((r & 0xFF) << 16) |

                ((g & 0xFF) << 8)  |

                ((b & 0xFF) << 0);

        testColorValueRange(r,g,b,a);

    }

    /**

     * Creates an opaque sRGB color with the specified combined RGB value

     * consisting of the red component in bits 16-23, the green component

     * in bits 8-15, and the blue component in bits 0-7.  The actual color

     * used in rendering depends on finding the best match given the

     * color space available for a particular output device.  Alpha is

     * defaulted to 255.

     *

     * @param rgb the combined RGB components

     * @see java.awt.image.ColorModel#getRGBdefault

     * @see #getRed

     * @see #getGreen

     * @see #getBlue

     * @see #getRGB

     */

    public Color(int rgb) {

        value = 0xff000000 | rgb;

    }

    /**

     * Creates an sRGB color with the specified combined RGBA value consisting

     * of the alpha component in bits 24-31, the red component in bits 16-23,

     * the green component in bits 8-15, and the blue component in bits 0-7.

     * If the <code>hasalpha</code> argument is <code>false</code>, alpha

     * is defaulted to 255.

     *

     * @param rgba the combined RGBA components

     * @param hasalpha <code>true</code> if the alpha bits are valid;

     *        <code>false</code> otherwise

     * @see java.awt.image.ColorModel#getRGBdefault

     * @see #getRed

     * @see #getGreen

     * @see #getBlue

     * @see #getAlpha

     * @see #getRGB

     */

    public Color(int rgba, boolean hasalpha) {

        if (hasalpha) {

            value = rgba;

        } else {

            value = 0xff000000 | rgba;

        }

    }

    /**

     * Creates an opaque sRGB color with the specified red, green, and blue

     * values in the range (0.0 - 1.0).  Alpha is defaulted to 1.0.  The

     * actual color used in rendering depends on finding the best

     * match given the color space available for a particular output

     * device.

     *

     * @throws IllegalArgumentException if <code>r</code>, <code>g</code>

     *        or <code>b</code> are outside of the range

     *        0.0 to 1.0, inclusive

     * @param r the red component

     * @param g the green component

     * @param b the blue component

     * @see #getRed

     * @see #getGreen

     * @see #getBlue

     * @see #getRGB

     */

    public Color(float r, float g, float b) {

        this( (int) (r*255+0.5), (int) (g*255+0.5), (int) (b*255+0.5));

        testColorValueRange(r,g,b,1.0f);

        frgbvalue = new float[3];

        frgbvalue[0] = r;

        frgbvalue[1] = g;

        frgbvalue[2] = b;

        falpha = 1.0f;

        fvalue = frgbvalue;

    }

    /**

     * Creates an sRGB color with the specified red, green, blue, and

     * alpha values in the range (0.0 - 1.0).  The actual color

     * used in rendering depends on finding the best match given the

     * color space available for a particular output device.

     * @throws IllegalArgumentException if <code>r</code>, <code>g</code>

     *        <code>b</code> or <code>a</code> are outside of the range

     *        0.0 to 1.0, inclusive

     * @param r the red component

     * @param g the green component

     * @param b the blue component

     * @param a the alpha component

     * @see #getRed

     * @see #getGreen

     * @see #getBlue

     * @see #getAlpha

     * @see #getRGB

     */

    public Color(float r, float g, float b, float a) {

        this((int)(r*255+0.5), (int)(g*255+0.5), (int)(b*255+0.5), (int)(a*255+0.5));

        frgbvalue = new float[3];

        frgbvalue[0] = r;

        frgbvalue[1] = g;

        frgbvalue[2] = b;

        falpha = a;

        fvalue = frgbvalue;

    }

    /**

     * Creates a color in the specified <code>ColorSpace</code>

     * with the color components specified in the <code>float</code>

     * array and the specified alpha.  The number of components is

     * determined by the type of the <code>ColorSpace</code>.  For

     * example, RGB requires 3 components, but CMYK requires 4

     * components.

     * @param cspace the <code>ColorSpace</code> to be used to

     *                  interpret the components

     * @param components an arbitrary number of color components

     *                      that is compatible with the <code>ColorSpace</code>

     * @param alpha alpha value

     * @throws IllegalArgumentException if any of the values in the

     *         <code>components</code> array or <code>alpha</code> is

     *         outside of the range 0.0 to 1.0

     * @see #getComponents

     * @see #getColorComponents

     */

    public Color(ColorSpace cspace, float components[], float alpha) {

        boolean rangeError = false;

        String badComponentString = "";

        int n = cspace.getNumComponents();

        fvalue = new float[n];

        for (int i = 0; i < n; i++) {

            if (components[i] < 0.0 || components[i] > 1.0) {

                rangeError = true;

                badComponentString = badComponentString + "Component " + i

                                     + " ";

            } else {

                fvalue[i] = components[i];