A

ARABIC_NUMERALS - Static variable in class com.github.cage.token.RandomCharacterGeneratorFactory

Arabic numeral character array.

C

Cage - Class in com.github.cage

Convenient entry class to control captcha generation.

Cage() - Constructor for class com.github.cage.Cage

Default constructor.

Cage(Painter, IGenerator<Font>, IGenerator<Color>, String, Float, IGenerator<String>, Random) - Constructor for class com.github.cage.Cage

Constructor.

calcDeltaArray(Rippler.AxisConfig, int) - Method in class com.github.cage.image.Rippler

Calculates wave delta array.

com.github.cage - package com.github.cage

This is the main package of Cage, for usage example see Cage or one of the predefined templates like GCage or YCage.

com.github.cage.image - package com.github.cage.image

Classes in this package are responsible for the actual image generation, the central class is Painter.

com.github.cage.token - package com.github.cage.token

Classes in this package are responsible for token generation, the central class is RandomTokenGenerator.

configureGraphics(Graphics, Font, Color) - Method in class com.github.cage.image.Painter

Configures graphics object before drawing text on it.

configureGraphicsQuality(Graphics2D) - Method in class com.github.cage.image.Painter

Sets quality related hints based on the quality field of this object.

ConstantColorGenerator - Class in com.github.cage.image

IGenerator implementation that returns always the same Color.

ConstantColorGenerator(Color) - Constructor for class com.github.cage.image.ConstantColorGenerator

Constructor.

createDefaultSpecialCharacterSets() - Static method in class com.github.cage.token.RandomCharacterGeneratorFactory

Helper function to build RandomCharacterGeneratorFactory.DEFAULT_SPECIAL_CHARACTER_SETS.

createImage() - Method in class com.github.cage.image.Painter

Creates a new image to draw upon.

D

DEFAULT_COMPRESS_RATIO - Static variable in class com.github.cage.Cage

Default compress ratio for image encoders.

DEFAULT_DEFAULT_CHARACTER_SET - Static variable in class com.github.cage.token.RandomCharacterGeneratorFactory

Default character set for the default case.

DEFAULT_FORMAT - Static variable in class com.github.cage.Cage

Default image encoding format.

DEFAULT_HEIGHT - Static variable in class com.github.cage.image.Painter

Default image height.

DEFAULT_SPECIAL_CHARACTER_SETS - Static variable in class com.github.cage.token.RandomCharacterGeneratorFactory

Special character sets for the default case.

DEFAULT_TOKEN_LEN_DELTA - Static variable in class com.github.cage.token.RandomTokenGenerator

Default maximum length of token is RandomTokenGenerator.DEFAULT_TOKEN_LEN_MIN + 2.

DEFAULT_TOKEN_LEN_MIN - Static variable in class com.github.cage.token.RandomTokenGenerator

Default minimum length of token.

DEFAULT_WIDTH - Static variable in class com.github.cage.image.Painter

Default image width.

draw(String, OutputStream) - Method in class com.github.cage.Cage

Generate an image and serialize it to the output.

draw(String) - Method in class com.github.cage.Cage

Generate an image and return it in a byte array.

draw(Font, Color, String) - Method in class com.github.cage.image.Painter

Generates a new captcha image.

draw(Graphics2D, String) - Method in class com.github.cage.image.Painter

Does some of the text transformation (calls Painter.transform(Graphics2D, String, GlyphVector)), scales, transforms and draws the result (also the outline if needed).

drawImage(String) - Method in class com.github.cage.Cage

Generates a captcha image.

E

EffectConfig - Class in com.github.cage.image

Class to represent used effect configuration by Painter.

EffectConfig() - Constructor for class com.github.cage.image.EffectConfig

Constructor.

EffectConfig(boolean, boolean, boolean, boolean, ScaleConfig) - Constructor for class com.github.cage.image.EffectConfig

Constructor.

ENGLISH_CONSONANTS - Static variable in class com.github.cage.token.RandomCharacterGeneratorFactory

English lower cased consonant character array.

ENGLISH_VOWELS - Static variable in class com.github.cage.token.RandomCharacterGeneratorFactory

English lower cased vowel character array.

F

fillBlurArray(float[]) - Method in class com.github.cage.image.Painter

Generates a random probability distribution.

filter(BufferedImage, BufferedImage) - Method in class com.github.cage.image.Rippler

Draws a rippled (waved) variant of source into destination.

G

GCage - Class in com.github.cage

Creates and configures a Cage instance that can generate captcha images similar to Google's.

GCage() - Constructor for class com.github.cage.GCage

 

getAmplitude() - Method in class com.github.cage.image.Rippler.AxisConfig

 

getBackground() - Method in class com.github.cage.image.Painter

 

getCandidates() - Method in class com.github.cage.ObjectRoulette

 

getCharacterGeneratorFactory() - Method in class com.github.cage.token.RandomTokenGenerator

 

getCompressRatio() - Method in class com.github.cage.Cage

 

getDefaultCharacterSet() - Method in class com.github.cage.token.RandomCharacterGeneratorFactory

 

getDelta() - Method in class com.github.cage.token.RandomTokenGenerator

 

getEffectConfig() - Method in class com.github.cage.image.Painter

 

getFonts() - Method in class com.github.cage.Cage

 

getForegrounds() - Method in class com.github.cage.Cage

 

getFormat() - Method in class com.github.cage.Cage

 

getHeight() - Method in class com.github.cage.image.Painter

 

getHorizontal() - Method in class com.github.cage.image.Rippler

 

getLength() - Method in class com.github.cage.image.Rippler.AxisConfig

 

getMinLength() - Method in class com.github.cage.token.RandomTokenGenerator

 

getPainter() - Method in class com.github.cage.Cage

 

getQuality() - Method in class com.github.cage.image.Painter

 

getScaleConfig() - Method in class com.github.cage.image.EffectConfig

 

getSpecialCharacterSets() - Method in class com.github.cage.token.RandomCharacterGeneratorFactory

 

getStart() - Method in class com.github.cage.image.Rippler.AxisConfig

 

getTokenGenerator() - Method in class com.github.cage.Cage

 

getVertical() - Method in class com.github.cage.image.Rippler

 

getWidth() - Method in class com.github.cage.image.Painter

 

getX() - Method in class com.github.cage.image.ScaleConfig

 

getY() - Method in class com.github.cage.image.ScaleConfig

 

H

HEIGHT - Static variable in class com.github.cage.YCage

Height of CAPTCHA image.

I

IGenerator<T> - Interface in com.github.cage

Object generator.

IGeneratorFactory<T> - Interface in com.github.cage

Factory creating IGenerators.

isBlurEnabled() - Method in class com.github.cage.image.EffectConfig

 

isOutlineEnabled() - Method in class com.github.cage.image.EffectConfig

 

isRippleEnabled() - Method in class com.github.cage.image.EffectConfig

 

isRotateEnabled() - Method in class com.github.cage.image.EffectConfig

 

N

next() - Method in interface com.github.cage.IGenerator

Returns an object with type T on every call.

next() - Method in class com.github.cage.image.ConstantColorGenerator

 

next() - Method in class com.github.cage.image.RgbColorGenerator

 

next() - Method in class com.github.cage.ObjectRoulette

 

next() - Method in class com.github.cage.token.RandomCharacterGeneratorFactory

 

next() - Method in class com.github.cage.token.RandomCharacterGeneratorFactory.RandomCharacterGenerator

 

next() - Method in class com.github.cage.token.RandomTokenGenerator

 

normalize(double, int) - Method in class com.github.cage.image.Rippler.AxisConfig

Normalizes parameter to fall into [0, multi * Math.PI].

O

ObjectRoulette<T> - Class in com.github.cage

An IGenerator implementation that returns a randomly chosen element from a predefined set of objects when ObjectRoulette.next() is called.

ObjectRoulette(Random, T...) - Constructor for class com.github.cage.ObjectRoulette

Constructor.

P

Painter - Class in com.github.cage.image

This class does most of the captcha drawing.

Painter() - Constructor for class com.github.cage.image.Painter

Constructor.

Painter(Random) - Constructor for class com.github.cage.image.Painter

Constructor.

Painter(int, int, Color, Painter.Quality, EffectConfig, Random) - Constructor for class com.github.cage.image.Painter

Constructor.

Painter.Quality - Enum in com.github.cage.image

Enumeration for different image quality levels.

postProcess(BufferedImage) - Method in class com.github.cage.image.Painter

Does some post processing on the generated image if needed.

R

RandomCharacterGeneratorFactory - Class in com.github.cage.token

Factory that can generate Character generating IGenerators.

RandomCharacterGeneratorFactory() - Constructor for class com.github.cage.token.RandomCharacterGeneratorFactory

Constructor.

RandomCharacterGeneratorFactory(Random) - Constructor for class com.github.cage.token.RandomCharacterGeneratorFactory

Constructor.

RandomCharacterGeneratorFactory(char[], Map<Character, char[]>, Random) - Constructor for class com.github.cage.token.RandomCharacterGeneratorFactory

Constructor.

RandomCharacterGeneratorFactory.RandomCharacterGenerator - Class in com.github.cage.token

Generates characters based on the settings of the factory.

RandomCharacterGeneratorFactory.RandomCharacterGenerator() - Constructor for class com.github.cage.token.RandomCharacterGeneratorFactory.RandomCharacterGenerator

 

RandomTokenGenerator - Class in com.github.cage.token

A simple random String generator that can be used to generate tokens for the captcha images.

RandomTokenGenerator() - Constructor for class com.github.cage.token.RandomTokenGenerator

Constructor.

RandomTokenGenerator(Random) - Constructor for class com.github.cage.token.RandomTokenGenerator

Constructor.

RandomTokenGenerator(Random, int) - Constructor for class com.github.cage.token.RandomTokenGenerator

Constructor.

RandomTokenGenerator(Random, int, int) - Constructor for class com.github.cage.token.RandomTokenGenerator

Constructor.

RandomTokenGenerator(Random, IGeneratorFactory<Character>, int, int) - Constructor for class com.github.cage.token.RandomTokenGenerator

Constructor.

RgbColorGenerator - Class in com.github.cage.image

Random RGB Color object generator.

RgbColorGenerator(Random) - Constructor for class com.github.cage.image.RgbColorGenerator

Constructor.

Rippler - Class in com.github.cage.image

A filter to generate ripple (wave) effected images.

Rippler(Rippler.AxisConfig, Rippler.AxisConfig) - Constructor for class com.github.cage.image.Rippler

Constructor.

Rippler.AxisConfig - Class in com.github.cage.image

Class to respresent wave tranforming information for an axis.

Rippler.AxisConfig(double, double, double) - Constructor for class com.github.cage.image.Rippler.AxisConfig

Constructor.

S

ScaleConfig - Class in com.github.cage.image

Used by EffectConfig to hold the scaling scalars for the captcha image.

ScaleConfig() - Constructor for class com.github.cage.image.ScaleConfig

Constructor.

ScaleConfig(float, float) - Constructor for class com.github.cage.image.ScaleConfig

Constructor.

serialize(BufferedImage, OutputStream) - Method in class com.github.cage.Cage

Serializes an image to an OutputStream.

T

TOKEN_DEFAULT_CHARACTER_SET - Static variable in class com.github.cage.YCage

Character set supplied to the RandomTokenGenerator used by this template.

TOKEN_LEN_DELTA - Static variable in class com.github.cage.YCage

Maximum length of token is 6 + 2.

TOKEN_LEN_MIN - Static variable in class com.github.cage.YCage

Minimum length of token.

transform(Graphics2D, String, GlyphVector) - Method in class com.github.cage.image.Painter

Does some of the text transformation (like rotation and symbol crowding).

V

valueOf(String) - Static method in enum com.github.cage.image.Painter.Quality

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.cage.image.Painter.Quality

Returns an array containing the constants of this enum type, in the order they are declared.

W

WIDTH - Static variable in class com.github.cage.YCage

Width of CAPTCHA image.

Y

YCage - Class in com.github.cage

Creates and configures a Cage instance that can generate captcha images similar to Yahoo's.

YCage() - Constructor for class com.github.cage.YCage

Constructor.

YCage(Random) - Constructor for class com.github.cage.YCage

Constructor.