Package com.github.tadukoo.view.paint.gradient

Class GradientBuilder<GradientType extends Gradient>

java.lang.Object

com.github.tadukoo.view.paint.gradient.GradientBuilder<GradientType>

Direct Known Subclasses:

LinearGradient.LinearGradientBuilder, RadialGradient.RadialGradientBuilder

public abstract class GradientBuilder<GradientType extends Gradient>
extends Object

Gradient Builder is an abstract builder for a Gradient to be extended by subclasses for making more specific Gradients, e.g. LinearGradient.

Since:

Alpha v.0.2

Version:

Alpha v.0.2.1

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<Color>	colors	The Colors involved in the Gradient
protected MultipleGradientPaint.ColorSpaceType	colorSpace	The color space involved in the Gradient
protected MultipleGradientPaint.CycleMethod	cycleMethod	The cycle method involved in the Gradient
protected final List<Float>	fractions	The fractions involved in the Gradient
protected AffineTransform	gradientTransform	The AffineTransform involved in the Gradient

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GradientBuilder()	Constructs a new GradientBuilder (to be called in subclasses)

Method Summary

Modifier and Type	Method	Description
final GradientType	build()	Builds the Gradient after checking for errors.
protected abstract GradientType	buildGradient()	Builds the actual Gradient.
protected final void	checkForErrors()	Used to verify the given parameters for the Gradient to ensure nothing went wrong.
protected abstract List<String>	checkForSubclassErrors()	Called by checkForErrors() when checking errors so subclasses can check for their own specific errors.
GradientBuilder<GradientType>	colorPoint(float fraction, Color color)
GradientBuilder<GradientType>	colorSpace(MultipleGradientPaint.ColorSpaceType colorSpace)
GradientBuilder<GradientType>	cycleMethod(MultipleGradientPaint.CycleMethod cycleMethod)
GradientBuilder<GradientType>	gradientTransform(AffineTransform gradientTransform)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

fractions

protected final List<Float> fractions

The fractions involved in the Gradient

colors

protected final List<Color> colors

The Colors involved in the Gradient

cycleMethod

protected MultipleGradientPaint.CycleMethod cycleMethod

The cycle method involved in the Gradient

colorSpace

protected MultipleGradientPaint.ColorSpaceType colorSpace

The color space involved in the Gradient

gradientTransform

protected AffineTransform gradientTransform

The AffineTransform involved in the Gradient

Constructor Details

GradientBuilder

protected GradientBuilder()

Constructs a new GradientBuilder (to be called in subclasses)

Method Details

colorPoint

public GradientBuilder<GradientType> colorPoint(float fraction,
 Color color)

Parameters:

fraction - The fraction to use for this color point

color - The Color to use for this color point

Returns:

this, to continue building

cycleMethod

public GradientBuilder<GradientType> cycleMethod(MultipleGradientPaint.CycleMethod cycleMethod)

Parameters:

cycleMethod - The cycle method involved in the Gradient

Returns:

this, to continue building

colorSpace

public GradientBuilder<GradientType> colorSpace(MultipleGradientPaint.ColorSpaceType colorSpace)

Parameters:

colorSpace - The color space involved in the Gradient

Returns:

this, to continue building

gradientTransform

public GradientBuilder<GradientType> gradientTransform(AffineTransform gradientTransform)

Parameters:

gradientTransform - The AffineTransform involved in the Gradient

Returns:

this, to continue building

checkForErrors

protected final void checkForErrors()

Used to verify the given parameters for the Gradient to ensure nothing went wrong.

Throws:

IllegalArgumentException - If there are any errors

checkForSubclassErrors

protected abstract List<String> checkForSubclassErrors()

Called by checkForErrors() when checking errors so subclasses can check for their own specific errors.

Returns:

A List of errors, which may be empty - it must not be null

build

public final GradientType build()

Builds the Gradient after checking for errors.

Returns:

The newly created Gradient

buildGradient

protected abstract GradientType buildGradient()

Builds the actual Gradient. This is implemented by the specific subclass.

Returns:

The newly built Gradient