001/* 002 * Shredzone Commons 003 * 004 * Copyright (C) 2012 Richard "Shred" Körber 005 * http://commons.shredzone.org 006 * 007 * This program is free software: you can redistribute it and/or modify 008 * it under the terms of the GNU Library General Public License as 009 * published by the Free Software Foundation, either version 3 of the 010 * License, or (at your option) any later version. 011 * 012 * This program is distributed in the hope that it will be useful, 013 * but WITHOUT ANY WARRANTY; without even the implied warranty of 014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 015 * GNU General Public License for more details. 016 * 017 * You should have received a copy of the GNU Library General Public License 018 * along with this program. If not, see <http://www.gnu.org/licenses/>. 019 */ 020package org.shredzone.commons.captcha; 021 022import java.awt.image.BufferedImage; 023 024/** 025 * A generator for captcha images. 026 * 027 * @author Richard "Shred" Körber 028 */ 029public interface CaptchaGenerator { 030 031 /** 032 * Gets the captcha image width. This method does not create an actual captcha image, 033 * and thus can be used e.g. for writign img width attributes. 034 */ 035 int getWidth(); 036 037 /** 038 * Gets the captcha image height. This method does not create an actual captcha image, 039 * and thus can be used e.g. for writign img width attributes. 040 */ 041 int getHeight(); 042 043 /** 044 * Creates a captcha image of the given text. 045 * 046 * @param text 047 * the text to be shown in the captcha image 048 * @return {@link BufferedImage} with the generated captcha 049 */ 050 BufferedImage createCaptcha(char[] text); 051 052}