Module org.refcodes.graphical

Package org.refcodes.graphical

Class RgbPixmapImageBuilder

java.lang.Object

org.refcodes.graphical.RgbPixmapImageBuilder

All Implemented Interfaces:

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

public class RgbPixmapImageBuilder
extends Object
implements PixmapImageBuilder<RgbPixel>

The Class RgbPixmapImageBuilderImpl.

Nested Class Summary

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

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

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

Constructor Summary

Constructors

Constructor	Description
RgbPixmapImageBuilder()

Method Summary

Modifier and Type	Method	Description
int	getHeight()	Retrieves the height from the height property.
int	getWidth()	Retrieves the width from the width property.
void	setDimension(int aWidth, int aHeight)	Sets the dimension.
void	setDimension(Dimension aDimension)	Sets the dimension.
void	setHeight(int aHeight)	Sets the height for the height property.
void	setImageInputStream(InputStream aImageStream)	Sets the InputStream for retrieving the image data for the image property.
void	setImageURL(URL aImageUrl)	Sets the URL for retrieving the image data for the image property.
void	setWidth(int aWidth)	Sets the width for the width property.
RgbPixmap	toPixmap()	To pixmap.
RgbPixmap	toPixmap(File aImageFile)	To pixmap.
RgbPixmap	toPixmap(InputStream aImageStream)	To pixmap.
RgbPixmapImageBuilder	withDimension(int aWidth, int aHeight)	With dimension.
RgbPixmapImageBuilder	withDimension(Dimension aDimension)	With dimension.
RgbPixmapImageBuilder	withHeight(int aHeight)	Sets the height for the height property.
RgbPixmapImageBuilder	withImageFile(File aImageFile)	Sets the File for retrieving the image data for the image property.
RgbPixmapImageBuilder	withImageInputStream(InputStream aImageStream)	Sets the input stream for retrieving the image data for the image property.
RgbPixmapImageBuilder	withImageURL(URL aImageUrl)	Sets the URL for retrieving the image data for the image property.
RgbPixmapImageBuilder	withWidth(int aWidth)	Sets the width for the width property.

Methods inherited from class java.lang.Object

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

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

letDimension, letDimension

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

letHeight

Methods inherited from interface org.refcodes.graphical.PixmapImageBuilder

setImageFile

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

letWidth

Constructor Details

RgbPixmapImageBuilder

public RgbPixmapImageBuilder()

Method Details

getWidth

public int getWidth()

Retrieves the width from the width property.

Specified by:

getWidth in interface WidthAccessor

Returns:

The width stored by the width property.

getHeight

public int getHeight()

Retrieves the height from the height property.

Specified by:

getHeight in interface HeightAccessor

Returns:

The height stored by the height property.

setDimension

public void setDimension(int aWidth,
 int aHeight)

Sets the dimension.

Specified by:

setDimension in interface Dimension.DimensionMutator

Parameters:

aWidth - the width

aHeight - the height

setDimension

public void setDimension(Dimension aDimension)

Sets the dimension.

Specified by:

setDimension in interface Dimension.DimensionMutator

Parameters:

aDimension - the new dimension

setWidth

public void setWidth(int aWidth)

Sets the width for the width property.

Specified by:

setWidth in interface WidthAccessor.WidthMutator

Parameters:

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

setHeight

public void setHeight(int aHeight)

Sets the height for the height property.

Specified by:

setHeight in interface HeightAccessor.HeightMutator

Parameters:

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

withDimension

public RgbPixmapImageBuilder withDimension(int aWidth,
 int aHeight)

With dimension.

Specified by:

withDimension in interface Dimension.DimensionBuilder<PixmapImageBuilder<RgbPixel>>

Parameters:

aWidth - the width

aHeight - the height

Returns:

the b

withDimension

public RgbPixmapImageBuilder withDimension(Dimension aDimension)

With dimension.

Specified by:

withDimension in interface Dimension.DimensionBuilder<PixmapImageBuilder<RgbPixel>>

Parameters:

aDimension - the dimension

Returns:

the b

withWidth

public RgbPixmapImageBuilder withWidth(int aWidth)

Sets the width for the width property.

Specified by:

withWidth in interface WidthAccessor.WidthBuilder<PixmapImageBuilder<RgbPixel>>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withHeight

public RgbPixmapImageBuilder withHeight(int aHeight)

Sets the height for the height property.

Specified by:

withHeight in interface HeightAccessor.HeightBuilder<PixmapImageBuilder<RgbPixel>>

Parameters:

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

Returns:

The builder for applying multiple build operations.

setImageInputStream

public void setImageInputStream(InputStream aImageStream)

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

Specified by:

setImageInputStream in interface PixmapImageBuilder<RgbPixel>

Parameters:

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

setImageURL

public void setImageURL(URL aImageUrl)

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

Specified by:

setImageURL in interface PixmapImageBuilder<RgbPixel>

Parameters:

aImageUrl - The image which's URL is to be stored by the image URL property.

toPixmap

public 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

public RgbPixmap toPixmap(InputStream aImageStream)
                   throws IOException

To pixmap.

Parameters:

aImageStream - the image stream

Returns:

the rgb pixmap

Throws:

IOException - thrown in case there were IO problems.

withImageInputStream

public 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

public 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

public 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

public 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.