Package com.xxl.tool.captcha

Class CaptchaTool

java.lang.Object

com.xxl.tool.captcha.CaptchaTool

public class CaptchaTool
extends Object

captcha tool

Author:

xuxueli 2025-09-13

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CaptchaTool.ArithmeticTextCreator	arithmetic text creator
static class	CaptchaTool.DefaultTextCreator	default text creator
static interface	CaptchaTool.DistortedEngine	image distorted engine
static class	CaptchaTool.FishEyeDistorted	鱼眼效果
static class	CaptchaTool.NoneDistorted	none distorted engine
static class	CaptchaTool.RippleDistorted	波纹效果
static class	CaptchaTool.ShadowDistorted	阴影效果
static interface	CaptchaTool.TextCreator	text creator
static class	CaptchaTool.TextResult	text result
static class	CaptchaTool.WaterRippleDistorted	水波纹效果

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TEXT_LOWERCASE
static final String	TEXT_NUMBER
static final String	TEXT_NUMBER_AND_LOWERCASE

Constructor Summary

Constructors

Constructor	Description
CaptchaTool()

Method Summary

Modifier and Type	Method	Description
static void	assertNotNull(Object object, String errorMessage)
static CaptchaTool	build()	create captcha tool
BufferedImage	createImage(CaptchaTool.TextResult textResult)	create captcha image
CaptchaTool.TextResult	createText()	create captcha text
Color	getBackgroundColorFrom()
Color	getBackgroundColorTo()
Color	getBorderColor()
Integer	getBorderThickness()
Integer	getCharSpace()
List<Color>	getColors()
List<CaptchaTool.DistortedEngine>	getDistortedEngines()
List<Font>	getFonts()
Integer	getFontSize()
Integer	getHeight()
Boolean	getIsBorderDrawn()
Color	getNoiseColor()
CaptchaTool.TextCreator	getTextCreator()
Integer	getWidth()
CaptchaTool	setBackgroundColorFrom(Color backgroundColorFrom)
CaptchaTool	setBackgroundColorTo(Color backgroundColorTo)
CaptchaTool	setBorderColor(Color borderColor)
CaptchaTool	setBorderThickness(Integer borderThickness)
CaptchaTool	setCharSpace(Integer charSpace)
CaptchaTool	setColors(List<Color> colors)
CaptchaTool	setDistortedEngines(List<CaptchaTool.DistortedEngine> distortedEngines)
CaptchaTool	setFonts(List<Font> fonts)
CaptchaTool	setFontSize(Integer fontSize)
CaptchaTool	setHeight(Integer height)
CaptchaTool	setIsBorderDrawn(Boolean isBorderDrawn)
CaptchaTool	setNoiseColor(Color noiseColor)
CaptchaTool	setTextCreator(CaptchaTool.TextCreator textCreator)
CaptchaTool	setWidth(Integer width)

Methods inherited from class java.lang.Object

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

Field Details

TEXT_NUMBER

public static final String TEXT_NUMBER

See Also:

• Constant Field Values

TEXT_LOWERCASE

public static final String TEXT_LOWERCASE

See Also:

• Constant Field Values

TEXT_NUMBER_AND_LOWERCASE

public static final String TEXT_NUMBER_AND_LOWERCASE

See Also:

• Constant Field Values

Constructor Details

CaptchaTool

public CaptchaTool()

Method Details

getTextCreator

public CaptchaTool.TextCreator getTextCreator()

setTextCreator

public CaptchaTool setTextCreator(CaptchaTool.TextCreator textCreator)

getWidth

public Integer getWidth()

setWidth

public CaptchaTool setWidth(Integer width)

getHeight

public Integer getHeight()

setHeight

public CaptchaTool setHeight(Integer height)

getColors

public List<Color> getColors()

setColors

public CaptchaTool setColors(List<Color> colors)

getFontSize

public Integer getFontSize()

setFontSize

public CaptchaTool setFontSize(Integer fontSize)

getFonts

public List<Font> getFonts()

setFonts

public CaptchaTool setFonts(List<Font> fonts)

getCharSpace

public Integer getCharSpace()

setCharSpace

public CaptchaTool setCharSpace(Integer charSpace)

getBackgroundColorFrom

public Color getBackgroundColorFrom()

setBackgroundColorFrom

public CaptchaTool setBackgroundColorFrom(Color backgroundColorFrom)

getBackgroundColorTo

public Color getBackgroundColorTo()

setBackgroundColorTo

public CaptchaTool setBackgroundColorTo(Color backgroundColorTo)

getIsBorderDrawn

public Boolean getIsBorderDrawn()

setIsBorderDrawn

public CaptchaTool setIsBorderDrawn(Boolean isBorderDrawn)

getBorderColor

public Color getBorderColor()

setBorderColor

public CaptchaTool setBorderColor(Color borderColor)

getBorderThickness

public Integer getBorderThickness()

setBorderThickness

public CaptchaTool setBorderThickness(Integer borderThickness)

getNoiseColor

public Color getNoiseColor()

setNoiseColor

public CaptchaTool setNoiseColor(Color noiseColor)

getDistortedEngines

public List<CaptchaTool.DistortedEngine> getDistortedEngines()

setDistortedEngines

public CaptchaTool setDistortedEngines(List<CaptchaTool.DistortedEngine> distortedEngines)

build

public static CaptchaTool build()

create captcha tool

Returns:

CaptchaTool

createText

public CaptchaTool.TextResult createText()

create captcha text

Returns:

TextResult

assertNotNull

public static void assertNotNull(Object object,
 String errorMessage)

createImage

public BufferedImage createImage(CaptchaTool.TextResult textResult)

create captcha image

Returns:

BufferedImage