Fills.java

/**
 *
 * The MIT License
 *
 * Copyright (c) 2011 the original author or authors.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:

 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.googlecode.charts4j;

import static com.googlecode.charts4j.collect.Preconditions.*;

/**
 * Static factory class for {@link Fill} hierarchy. Construct
 * {@link LinearGradientFill}, {@link LinearStripesFill}, {@link Fill}
 *
 * @author Julien Chastang (julien.c.chastang at gmail dot com)
 *
 */
public final class Fills {

    /**
     * Static factory class can never be instantiated.
     */
    private Fills() {
        throw new AssertionError();
    }

    /**
     * Create linear gradient fill.
     *
     * @param angle
     *            specifies the angle of the gradient between 0 (horizontal) and
     *            90 (vertical).
     * @param color
     *            color for gradient.Cannot be null.
     * @param offset
     *            specify at what point the color is pure where: 0 specifies the
     *            left-most chart position and 100 the right-most.
     *
     * @return a newly constructed linear gradient fill
     *
     */
    public static LinearGradientFill newLinearGradientFill(final int angle, final Color color, final double offset) {
        checkNotNull(color, "color cannot be null");
        checkArgument(offset >= Data.MIN_VALUE && offset <= Data.MAX_VALUE, "offset must be between 0 and 100");
        return new LinearGradientFill(angle, color, offset);
    }

    /**
     * Create linear stripes fill.
     *
     * @param angle
     *            specifies the angle of the gradient between 0 (horizontal) and
     *            90 (vertical)
     * @param color
     *            color of stripe.
     * @param width
     *            must be between 0 and 100 where 100 is the full width of the
     *            chart. Stripes are repeated until the chart is filled.
     *
     * @return a newly constructed linear stripes fill
     */
    public static LinearStripesFill newLinearStripesFill(final int angle, final Color color, final double width) {
        checkNotNull(color, "color cannot be null");
        checkArgument(width >= Data.MIN_VALUE && width <= Data.MAX_VALUE, "width must be between 0 and 100");
        return new LinearStripesFill(angle, color, width);
    }

    /**
     * Create a solid fill.
     *
     * @param color
     *            color of solid fill.
     * @return a newly constructed solid fill
     */
    public static Fill newSolidFill(final Color color) {
        return new SolidFill(color);
    }
}