Package org.refcodes.graphical

Interface RgbPixmapImageBuilder

All Superinterfaces:

Dimension, Dimension.DimensionBuilder<RgbPixel>, Dimension.DimensionMutator, Dimension.DimensionProperty, HeightAccessor, HeightAccessor.HeightBuilder<RgbPixel>, HeightAccessor.HeightMutator, HeightAccessor.HeightProperty, PixmapImageBuilder<RgbPixel>, WidthAccessor, WidthAccessor.WidthBuilder<RgbPixel>, WidthAccessor.WidthMutator, WidthAccessor.WidthProperty

All Known Implementing Classes:

RgbPixmapImageBuilderImpl

public interface RgbPixmapImageBuilder
extends PixmapImageBuilder<RgbPixel>

The Interface RgbPixmapImageBuilder.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.graphical.Dimension

Dimension.DimensionBuilder<B extends Dimension.DimensionBuilder<B>>, Dimension.DimensionMutator, Dimension.DimensionProperty, Dimension.DimensionPropertyBuilder

Nested classes/interfaces inherited from interface org.refcodes.graphical.HeightAccessor

HeightAccessor.HeightBuilder<B extends HeightAccessor.HeightBuilder<B>>, HeightAccessor.HeightMutator, HeightAccessor.HeightProperty

Nested classes/interfaces inherited from interface org.refcodes.graphical.WidthAccessor

WidthAccessor.WidthBuilder<B extends WidthAccessor.WidthBuilder<B>>, WidthAccessor.WidthMutator, WidthAccessor.WidthProperty

Method Summary

Modifier and Type	Method	Description
static RgbPixmapImageBuilder	build()	This is a convenience method for easily instantiating the according builder.
RgbPixmap	toPixmap()	To pixmap.
default RgbPixmap	toPixmap(File aImageFile)	To pixmap.
RgbPixmap	toPixmap(InputStream aImageStream)	To pixmap.
RgbPixmap	toPixmap(URL aImageUrl)	To pixmap.
PixmapImageBuilder<RgbPixel>	withDimension(int aWidth, int aHeight)	With dimension.
PixmapImageBuilder<RgbPixel>	withDimension(Dimension aDimension)	With dimension.
PixmapImageBuilder<RgbPixel>	withHeight(int aHeight)	Sets the height for the height property.
default RgbPixmapImageBuilder	withImageFile(File aImageFile)	Sets the File for retrieving the image data for the image property.
default RgbPixmapImageBuilder	withImageInputStream(InputStream aImageStream)	Sets the input stream for retrieving the image data for the image property.
default RgbPixmapImageBuilder	withImageURL(URL aImageUrl)	Sets the URL for retrieving the image data for the image property.
PixmapImageBuilder<RgbPixel>	withWidth(int aWidth)	Sets the width for the width property.

Methods inherited from interface org.refcodes.graphical.Dimension

equals

Methods inherited from interface org.refcodes.graphical.Dimension.DimensionMutator

setDimension, setDimension

Methods inherited from interface org.refcodes.graphical.HeightAccessor

getHeight

Methods inherited from interface org.refcodes.graphical.HeightAccessor.HeightMutator

setHeight

Methods inherited from interface org.refcodes.graphical.PixmapImageBuilder

setImageFile, setImageInputStream, setImageURL

Methods inherited from interface org.refcodes.graphical.WidthAccessor

getWidth

Methods inherited from interface org.refcodes.graphical.WidthAccessor.WidthMutator

setWidth

Method Detail

withWidth

PixmapImageBuilder<RgbPixel> withWidth(int aWidth)

Sets the width for the width property.

Specified by:

withWidth in interface WidthAccessor.WidthBuilder<RgbPixel>

Parameters:

aWidth - The width to be stored by the width property.

Returns:

The builder for applying multiple build operations.

withDimension

PixmapImageBuilder<RgbPixel> withDimension(int aWidth,
                                           int aHeight)

With dimension.

Specified by:

withDimension in interface Dimension.DimensionBuilder<RgbPixel>

Parameters:

aWidth - the width

aHeight - the height

Returns:

the b

withDimension

PixmapImageBuilder<RgbPixel> withDimension(Dimension aDimension)

With dimension.

Specified by:

withDimension in interface Dimension.DimensionBuilder<RgbPixel>

Parameters:

aDimension - the dimension

Returns:

the b

withHeight

PixmapImageBuilder<RgbPixel> withHeight(int aHeight)

Sets the height for the height property.

Specified by:

withHeight in interface HeightAccessor.HeightBuilder<RgbPixel>

Parameters:

aHeight - The height to be stored by the height property.

Returns:

The builder for applying multiple build operations.

withImageInputStream

default RgbPixmapImageBuilder withImageInputStream(InputStream aImageStream)

Sets the input stream for retrieving the image data for the image property.

Specified by:

withImageInputStream in interface PixmapImageBuilder<RgbPixel>

Parameters:

aImageStream - The image which's InputStream is to be stored by the image InputStream property.

Returns:

The builder for applying multiple build operations.

withImageFile

default RgbPixmapImageBuilder withImageFile(File aImageFile)
                                     throws FileNotFoundException

Sets the File for retrieving the image data for the image property.

Specified by:

withImageFile in interface PixmapImageBuilder<RgbPixel>

Parameters:

aImageFile - The image file which's InputStream is to be stored by the image InputStream property.

Returns:

The builder for applying multiple build operations.

Throws:

FileNotFoundException - in case the file was not found.

withImageURL

default RgbPixmapImageBuilder withImageURL(URL aImageUrl)

Sets the URL for retrieving the image data for the image property.

Specified by:

withImageURL in interface PixmapImageBuilder<RgbPixel>

Parameters:

aImageUrl - the URL

Returns:

The builder for applying multiple build operations.

toPixmap

RgbPixmap toPixmap()
            throws IOException

To pixmap.

Specified by:

toPixmap in interface PixmapImageBuilder<RgbPixel>

Returns:

the pixmap

Throws:

IOException - thrown in case of IO related problems.

toPixmap

RgbPixmap toPixmap(URL aImageUrl)
            throws IOException

To pixmap.

Parameters:

aImageUrl - the image url

Returns:

the rgb pixmap

Throws:

IOException - thrown in ase there were IO problems.

toPixmap

RgbPixmap toPixmap(InputStream aImageStream)
            throws IOException

To pixmap.

Parameters:

aImageStream - the image stream

Returns:

the rgb pixmap

Throws:

IOException - thrown in ase there were IO problems.

toPixmap

default RgbPixmap toPixmap(File aImageFile)
                    throws IOException

To pixmap.

Parameters:

aImageFile - the image file

Returns:

the rgb pixmap

Throws:

IOException - thrown in ase there were IO problems.

build

static RgbPixmapImageBuilder build()

This is a convenience method for easily instantiating the according builder.

Returns:

an instance (using a default implementation) of this builder