ml.miron.captcha.image

Class Captcha.Builder

java.lang.Object

ml.miron.captcha.image.Captcha.Builder

Enclosing class:

Captcha

public static class Captcha.Builder
extends Object

Captcha class builder.

Constructor Summary

Constructors

Constructor and Description
Builder(int width, int height) Creates a Captcha.Builder with specified width and height.

Method Summary

Modifier and Type	Method and Description
Captcha.Builder	addBackground() Add a background using the default TransparentBackground.
Captcha.Builder	addBackground(Background background) Add a background using the given Background.
Captcha.Builder	addBorder() Draw a single-pixel wide black border around the image.
Captcha.Builder	addNoise() Add noise using the default CurvedLineNoiseProducer.
Captcha.Builder	addNoise(NoiseProducer noise) Add noise using the given NoiseProducer.
Captcha.Builder	addText() Add answer to the captcha using the DefaultTextProducer.
Captcha.Builder	addText(TextProducer txtProd) ADd answer to the captcha using the given TextProducer.
Captcha.Builder	addText(TextProducer txtProd, WordRenderer wRenderer) ADd answer to the captcha using the given TextProducer, and render it to the image using the given WordRenderer.
Captcha.Builder	addText(WordRenderer wordRenderer) Add answer to the captcha with specified instance of WordRenderer.
Captcha	build() Builds the captcha.
Captcha.Builder	gimp() Gimp the image using the default FishEyeRenderer.
Captcha.Builder	gimp(Renderer renderer) Gimp the image using the given Renderer.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(int width,
               int height)

Creates a Captcha.Builder with specified width and height.

Parameters:

width - width of captcha.

height - height of captcha.

Method Detail

addBackground

public Captcha.Builder addBackground()

Add a background using the default TransparentBackground.

Returns:

the current instance of Captcha.Builder.

addBackground

public Captcha.Builder addBackground(Background background)

Add a background using the given Background.

Parameters:

background - the instance of Background.

Returns:

the current instance of Captcha.Builder.

addText

public Captcha.Builder addText(WordRenderer wordRenderer)

Add answer to the captcha with specified instance of WordRenderer.

Parameters:

wordRenderer - the instance of WordRenderer.

Returns:

the current instance of Captcha.Builder.

addText

public Captcha.Builder addText()

Add answer to the captcha using the DefaultTextProducer.

Returns:

the current instance of Captcha.Builder.

addText

public Captcha.Builder addText(TextProducer txtProd)

ADd answer to the captcha using the given TextProducer.

Parameters:

txtProd - the instance of TextProducer.

Returns:

the current instance of Captcha.Builder.

addText

public Captcha.Builder addText(TextProducer txtProd,
                               WordRenderer wRenderer)

ADd answer to the captcha using the given TextProducer, and render it to the image using the given WordRenderer.

Parameters:

txtProd - the instance of TextProducer.

wRenderer - the instance of WordRenderer.

Returns:

the current instance of Captcha.Builder.

addNoise

public Captcha.Builder addNoise()

Add noise using the default CurvedLineNoiseProducer.

Returns:

the current instance of Captcha.Builder.

addNoise

public Captcha.Builder addNoise(NoiseProducer noise)

Add noise using the given NoiseProducer.

Parameters:

noise - the instance of NoiseProducer.

Returns:

the current instance of Captcha.Builder.

gimp

public Captcha.Builder gimp()

Gimp the image using the default FishEyeRenderer.

Returns:

the current instance of Captcha.Builder.

gimp

public Captcha.Builder gimp(Renderer renderer)

Gimp the image using the given Renderer.

Parameters:

renderer - the instance of Renderer.

Returns:

the current instance of Captcha.Builder.

addBorder

public Captcha.Builder addBorder()

Draw a single-pixel wide black border around the image.

Returns:

the current instance of Captcha.Builder.

build

public Captcha build()

Builds the captcha. This method should always be called, and should always be called last.

Returns:

The constructed captcha.