cn.hutool.captcha

Interface ICaptcha

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractCaptcha, CircleCaptcha, GifCaptcha, LineCaptcha, ShearCaptcha

public interface ICaptcha
extends Serializable

验证码接口，提供验证码对象接口定义

Author:

looly

Method Summary

Modifier and Type	Method and Description
void	createCode() 创建验证码，实现类需同时生成随机验证码字符串和验证码图片
String	getCode() 获取验证码的文字内容
boolean	verify(String userInputCode) 验证验证码是否正确，建议忽略大小写
void	write(OutputStream out) 将验证码写出到目标流中

Method Detail

createCode

void createCode()

创建验证码，实现类需同时生成随机验证码字符串和验证码图片

getCode

String getCode()

获取验证码的文字内容

Returns:

验证码文字内容

verify

boolean verify(String userInputCode)

验证验证码是否正确，建议忽略大小写

Parameters:

userInputCode - 用户输入的验证码

Returns:

是否与生成的一直

write

void write(OutputStream out)

将验证码写出到目标流中

Parameters:

out - 目标流