Module org.refcodes.graphical

Package org.refcodes.graphical

Interface PixmapImageBuilder<PX>

Type Parameters:

PX - the generic type

All Superinterfaces:

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

All Known Implementing Classes:

RgbPixmapImageBuilder

public interface PixmapImageBuilder<PX>
extends Dimension.DimensionProperty, Dimension.DimensionBuilder<PixmapImageBuilder<PX>>

The Interface PixmapImageBuilder.

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method	Description
default void	setImageFile(File aImageFile)	Sets the URL for retrieving the image data for the image 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.
Pixmap<PX>	toPixmap()	To pixmap.
default PixmapImageBuilder<PX>	withImageFile(File aImageFile)	Sets the File for retrieving the image data for the image property.
default PixmapImageBuilder<PX>	withImageInputStream(InputStream aImageStream)	Sets the input stream for retrieving the image data for the image property.
default PixmapImageBuilder<PX>	withImageURL(URL aUrl)	Sets the URL for retrieving the image data for the image property.

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

withDimension, withDimension

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

setDimension, setDimension

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

letDimension, letDimension

Methods inherited from interface org.refcodes.graphical.HeightAccessor

getHeight

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

withHeight

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

setHeight

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

letHeight

Methods inherited from interface org.refcodes.graphical.WidthAccessor

getWidth

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

withWidth

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

setWidth

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

letWidth

Method Detail

toPixmap

Pixmap<PX> toPixmap()
             throws IOException

To pixmap.

Returns:

the pixmap

Throws:

IOException - thrown in case of IO related problems.

setImageInputStream

void setImageInputStream(InputStream aImageStream)

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

Parameters:

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

withImageInputStream

default PixmapImageBuilder<PX> withImageInputStream(InputStream aImageStream)

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

Parameters:

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

Returns:

The builder for applying multiple build operations.

setImageURL

void setImageURL(URL aImageUrl)

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

Parameters:

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

withImageURL

default PixmapImageBuilder<PX> withImageURL(URL aUrl)

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

Parameters:

aUrl - the URL

Returns:

The builder for applying multiple build operations.

setImageFile

default void setImageFile(File aImageFile)
                   throws FileNotFoundException

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

Parameters:

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

Throws:

FileNotFoundException - in case the file was not found.

withImageFile

default PixmapImageBuilder<PX> withImageFile(File aImageFile)
                                      throws FileNotFoundException

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

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.