org.osgl.util

Class Img.Processor<PROCESSOR extends Img.Processor<PROCESSOR,STAGE>,STAGE extends Img.ProcessorStage<STAGE,PROCESSOR>>

java.lang.Object

org.osgl.Lang.FuncBase

org.osgl.Lang.F0<ELEMENT>

org.osgl.Lang.Provider<PRODUCT>

org.osgl.Lang.Producer<BufferedImage>

org.osgl.util.Img.Processor<PROCESSOR,STAGE>

All Implemented Interfaces:

Lang.Func0<BufferedImage>

Direct Known Subclasses:

Img.BinarySourceProcessor, Img.Cropper, Img.Filter, Img.Flip, Img.Resizer

Enclosing class:

Img

public abstract static class Img.Processor<PROCESSOR extends Img.Processor<PROCESSOR,STAGE>,STAGE extends Img.ProcessorStage<STAGE,PROCESSOR>>
extends Lang.Producer<BufferedImage>

Base class for image operator function which provides source width, height, ratio parameters on demand

Field Summary

Fields

Modifier and Type	Field and Description
protected Graphics2D	g The graphics
protected BufferedImage	source The source image
protected int	sourceHeight The source image height
protected double	sourceRatio The source image width/height ratio
protected int	sourceWidth The source image width
protected BufferedImage	target The target image

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Processor()

Method Summary

Modifier and Type	Method and Description
protected void	beforeRun()
protected Graphics2D	cloneSource()
protected Graphics2D	createGraphics2D() Create the Graphics2D.
protected STAGE	createStage() Create a builder for this processor.
protected STAGE	createStage(BufferedImage source) Create a builder for this processor.
protected void	createTarget() Create target image using source width/height.
protected Graphics2D	g() Get Graphics2D instance.
STAGE	process(BufferedImage source)
STAGE	process(InputStream is)
BufferedImage	produce()
protected abstract BufferedImage	run()
protected void	setTargetSpec(int w, int h) Create target image using specified width and height.
protected void	setTargetSpec(int w, int h, boolean withAlphaChannel) Create target image using specified width, height and alpha channel flag
Img.Processor	source(BufferedImage source) Set source image.

Methods inherited from class org.osgl.Lang.Producer

get

Methods inherited from class org.osgl.Lang.Provider

apply

Methods inherited from class org.osgl.Lang.F0

andThen, andThen, applyOrElse, lift, orElse

Methods inherited from class org.osgl.Lang.FuncBase

breakOut

Methods inherited from class java.lang.Object

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

Field Detail

source

protected BufferedImage source

The source image

sourceWidth

protected int sourceWidth

The source image width

sourceHeight

protected int sourceHeight

The source image height

sourceRatio

protected double sourceRatio

The source image width/height ratio

target

protected BufferedImage target

The target image

g

protected Graphics2D g

The graphics

Constructor Detail

Processor

protected Processor()

Method Detail

createStage

protected final STAGE createStage()

Create a builder for this processor.

To provide better fluent coding experience, sub class can overwrite this function to provide specified builder instance instead of a general ProcessorBuilder as provided here

Returns:

a builder for this processor

createStage

protected STAGE createStage(BufferedImage source)

Create a builder for this processor.

To provide better fluent coding experience, sub class can overwrite this function to provide specified builder instance instead of a general ProcessorBuilder as provided here

Parameters:

source - the source image

Returns:

a builder for this processor

produce

public BufferedImage produce()

Specified by:

produce in class Lang.Producer<BufferedImage>

beforeRun

protected void beforeRun()

run

protected abstract BufferedImage run()

source

public Img.Processor source(BufferedImage source)

Set source image. This method will calculate and cache the following parameters about the source image:

• sourceWidth
• sourceHeight
• sourceRatio

Parameters:

source - the source image

Returns:

this Processor instance

process

public STAGE process(InputStream is)

process

public STAGE process(BufferedImage source)

g

protected Graphics2D g()

Get Graphics2D instance. If it is not created yet then call createGraphics2D() to create the instance

Returns:

the g instance

cloneSource

protected Graphics2D cloneSource()

createGraphics2D

protected Graphics2D createGraphics2D()

Create the Graphics2D. This method will trigger createTarget() method if target has not been created yet

Returns:

an new Graphics2D

createTarget

protected void createTarget()

Create target image using source width/height. It will use source color model to check if alpha channel should be be added or not

setTargetSpec

protected void setTargetSpec(int w,
                             int h)

Create target image using specified width and height.

This method will use source code model it check if alpha channel should be added or not

Parameters:

w - the width of target image

h - the height of target image

setTargetSpec

protected void setTargetSpec(int w,
                             int h,
                             boolean withAlphaChannel)

Create target image using specified width, height and alpha channel flag

Parameters:

w - the width of target image

h - the height of target image

withAlphaChannel - whether it shall be created with alpha channel