ml.miron.captcha.image

Class Captcha

java.lang.Object

ml.miron.captcha.image.Captcha

public final class Captcha
extends Object

A builder for generating a captcha image/answer pair.

Example for generating a new captcha:

Captcha nl.captcha = new Captcha.Builder(200, 50)
        .addText()
        .addBackground()
        .build();

Note that the build() must always be called last. Other methods are optional, and can sometimes be repeated. For example:

Captcha nl.captcha = new Captcha.Builder(200, 50)
        .addText()
        .addNoise()
        .addNoise()
        .addNoise()
        .addBackground()
        .build();

Adding multiple background has no affect; the last background added will simply be the one that is eventually rendered.

Author:

James Childers, Evgeny Mironenko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Captcha.Builder Captcha class builder.

Method Summary

Modifier and Type	Method and Description
String	getAnswer() Returns the answer for captcha.
BufferedImage	getImage() Get the PNG captcha image.
boolean	isCorrect(String answer) Returns true if specified answer if correct, otherwise false.

Methods inherited from class java.lang.Object

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

Method Detail

isCorrect

public boolean isCorrect(String answer)

Returns true if specified answer if correct, otherwise false.

Parameters:

answer - answer for captcha.

Returns:

see description.

getAnswer

public String getAnswer()

Returns the answer for captcha.

Returns:

see description.

getImage

public BufferedImage getImage()

Get the PNG captcha image.

Returns:

see description.