Groovy Documentation

src.groovy.pl.burningice.plugins.image.file
Class ImageFile

java.lang.Object
  src.groovy.pl.burningice.plugins.image.file.ImageFile

class ImageFile

Base class for all image sources (File, MultipartFile)

author:
pawel.gdula@burningice.pl


Property Summary
static java.lang.String BMP_EXTENSION

static java.lang.String GIF_EXTENSION

private static def GIF_OUTPUT_FORMAT

Gif image output format

static java.lang.String JPG_EXTENSION

static java.lang.String PNG_EXTENSION

def extensionEncoderMapping

Mapping file extension >> JAI encoder

byte[] source

java.lang.String sourceFileName

Name of the source file

 
Constructor Summary
ImageFile(java.lang.String sourceFileName, byte[] source)

Default constructor

 
Method Summary
BufferedImage getAsBufferedImage()

Returns uploaded image as BufferedImage

byte[] getAsByteArray()

Returns uploaded image as byte array

javax.media.jai.RenderedOp getAsJaiStream()

Returns file as JAI RenderedOp object

def getEncoder()

Method returns encoder for file Encoder is mapped by file extension

def getExtension()

Method returns file extension If there is GIF file, it will be transformed into format specified by GIF_OUTPUT_FORMAT const

SeekableStream getInputStream()

Returns InputStream object representing current file

def getName()

Method returns name of file If file is gif, it will replace gif extension by format specified by GIF_OUTPUT_FORMAT

Dimension getSize()

Allows to get size of current image

private byte[] toByteArray(BufferedImage image)

Converts BufferedImage object pass as a parameter to byte array

void update(BufferedImage image)

Allows to update current image data

 
Methods inherited from class java.lang.Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Property Detail

BMP_EXTENSION

public static final java.lang.String BMP_EXTENSION


GIF_EXTENSION

public static final java.lang.String GIF_EXTENSION


GIF_OUTPUT_FORMAT

private static final def GIF_OUTPUT_FORMAT
Gif image output format
const:
String


JPG_EXTENSION

public static final java.lang.String JPG_EXTENSION


PNG_EXTENSION

public static final java.lang.String PNG_EXTENSION


extensionEncoderMapping

@Lazy
def extensionEncoderMapping
Mapping file extension >> JAI encoder
var:
[:]


source

byte[] source


sourceFileName

java.lang.String sourceFileName
Name of the source file
var:
String


 
Constructor Detail

ImageFile

public ImageFile(java.lang.String sourceFileName, byte[] source)
Default constructor
param:
name Original file name


 
Method Detail

getAsBufferedImage

public BufferedImage getAsBufferedImage()
Returns uploaded image as BufferedImage
return:
Uploaded image as BufferedImage


getAsByteArray

public byte[] getAsByteArray()
Returns uploaded image as byte array
return:
Uploaded image as byte array


getAsJaiStream

public javax.media.jai.RenderedOp getAsJaiStream()
Returns file as JAI RenderedOp object
return:
RenderedOp


getEncoder

public def getEncoder()
Method returns encoder for file Encoder is mapped by file extension
return:
String


getExtension

public def getExtension()
Method returns file extension If there is GIF file, it will be transformed into format specified by GIF_OUTPUT_FORMAT const
return:
String


getInputStream

public SeekableStream getInputStream()
Returns InputStream object representing current file
return:
InputStream


getName

public def getName()
Method returns name of file If file is gif, it will replace gif extension by format specified by GIF_OUTPUT_FORMAT
return:
String


getSize

public Dimension getSize()
Allows to get size of current image
return:
Dimension object representing size of current image


toByteArray

private byte[] toByteArray(BufferedImage image)
Converts BufferedImage object pass as a parameter to byte array
param:
image BufferedImage object that should be transformed to byte array
return:
Image as byte array


update

void update(BufferedImage image)
Allows to update current image data
param:
image Changed image that should be used as new one


 

Groovy Documentation