de.digitalcollections.iiif.image.model.api.v2

Interface Image

public interface Image

NOTE: Even though this interface suggests that transformations are lazy, this is **not** binding. That is, between the first call to any of the transformation methods and the final `performTransformation` call, no assumptions can be made about the actual image data. The only guarantee is, that after having called `performTransformation`, the image has actually undergone the applied transformations. Implementors are encouraged to maintain a flag in the object's state that indicates whether a transformation is in progress (i.e. `performTransformation` has not been called yet) and raise an UnsupportedOperationException upon calling `toByteArray` if the flag is set.

Method Summary

Modifier and Type	Method and Description
Image	convert(ImageFormat format)
Image	crop(RegionParameters params)
Image	flipHorizontally()
ImageFormat	getFormat()
int	getHeight()
int	getWidth()
void	performTransformation()
Image	rotate(int arcDegree)
Image	scale(ResizeParameters params)
byte[]	toByteArray()
Image	toDepth(ImageBitDepth depth)

Method Detail

getFormat

ImageFormat getFormat()

getHeight

int getHeight()

getWidth

int getWidth()

toByteArray

byte[] toByteArray()
            throws UnsupportedOperationException,
                   IOException

Throws:

UnsupportedOperationException

IOException

crop

Image crop(RegionParameters params)
    throws UnsupportedOperationException,
           InvalidParametersException

Throws:

UnsupportedOperationException

InvalidParametersException

scale

Image scale(ResizeParameters params)
     throws UnsupportedOperationException,
            InvalidParametersException,
            TransformationException

Throws:

UnsupportedOperationException

InvalidParametersException

TransformationException

rotate

Image rotate(int arcDegree)
      throws UnsupportedOperationException,
             InvalidParametersException

Throws:

UnsupportedOperationException

InvalidParametersException

flipHorizontally

Image flipHorizontally()

toDepth

Image toDepth(ImageBitDepth depth)
       throws UnsupportedOperationException

Throws:

UnsupportedOperationException

convert

Image convert(ImageFormat format)
       throws UnsupportedOperationException,
              TransformationException

Throws:

UnsupportedOperationException

TransformationException

performTransformation

void performTransformation()
                    throws TransformationException

Throws:

TransformationException