org.osgl.util

Enum Img

java.lang.Object

java.lang.Enum<Img>

org.osgl.util.Img

All Implemented Interfaces:

Serializable, Comparable<Img>

public enum Img
extends Enum<Img>

Image utilities

Disclaim: some of the logic in this class comes from https://github.com/playframework/play1/blob/master/framework/src/play/libs/Images.java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Img._Load<T extends Img._Load>
static class	Img.BinarySourceProcessor<PROCESSOR extends Img.BinarySourceProcessor<PROCESSOR,STAGE>,STAGE extends Img.ProcessorStage<STAGE,PROCESSOR>> The base class that process two image sources and produce result image
static class	Img.Blur
static class	Img.Concatenater
static class	Img.Cropper
static class	Img.Direction The direction used to process image
static class	Img.F The namespace for functions
static class	Img.Filter<FILTER extends Img.Filter<FILTER,STAGE>,STAGE extends Img.ProcessorStage<STAGE,FILTER>>
static class	Img.Flip
static class	Img.NoiseMaker
static class	Img.Processor<PROCESSOR extends Img.Processor<PROCESSOR,STAGE>,STAGE extends Img.ProcessorStage<STAGE,PROCESSOR>> Base class for image operator function which provides source width, height, ratio parameters on demand
static class	Img.ProcessorStage<STAGE extends Img.ProcessorStage<STAGE,PROCESSOR>,PROCESSOR extends Img.Processor<PROCESSOR,STAGE>>
static class	Img.Random
static class	Img.Resizer Resize an image
static class	Img.TextWriter

Field Summary

Fields

Modifier and Type	Field and Description
static Color	COLOR_TRANSPARENT
static String	DEF_MIME_TYPE The default image MIME type when not specified
static String	GIF_MIME_TYPE
static String	JPG_MIME_TYPE
static String	PNG_MIME_TYPE
static String	TRACKING_PIXEL_BASE64 Base64 string of a tracking pixel image in gif format
static byte[]	TRACKING_PIXEL_BYTES Byte array of a tracking pixel image in gif format

Method Summary

Modifier and Type	Method and Description
static Img.Blur.Stage	blur(Lang.Func0<BufferedImage> imageProvider)
static Img.Concatenater.Stage	concat(Lang.Func0<BufferedImage> image1)
static Img.Concatenater.Stage	concat(Lang.Func0<BufferedImage> image1, Lang.Func0<BufferedImage> image2)
static Img.Cropper.Stage	crop(Lang.Func0<BufferedImage> imageProvider)
static Img.Flip.Stage	flip(Lang.Func0<BufferedImage> imageProvider)
static ImageOutputStream	os(File file)
static ImageOutputStream	os(OutputStream os)
static BufferedImage	read(File file)
static BufferedImage	read(InputStream is)
static BufferedImage	read(URL url)
static Img.Resizer.Stage	resize(Lang.Func0<BufferedImage> imageProvider)
static Img._Load	source(BufferedImage image)
static Img._Load	source(File file)
static Img._Load	source(InputStream is)
static Img._Load	source(Lang.Func0<BufferedImage> imageProducer)
static Img._Load	source(URL url)
static String	toBase64(byte[] bytes, String mimeType) Encode an image to base64 using a data: URI
static String	toBase64(File image) Encode an image to base64 using a data: URI
static String	toBase64(InputStream inputStream, String mimeType) Encode an image to base64 using a data: URI
static Img	valueOf(String name) Returns the enum constant of this type with the specified name.
static Img[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static Img.TextWriter.Stage	watermark(Lang.Func0<BufferedImage> imageProvider)

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEF_MIME_TYPE

public static final String DEF_MIME_TYPE

The default image MIME type when not specified

The value is image/png

See Also:

Constant Field Values

GIF_MIME_TYPE

public static final String GIF_MIME_TYPE

See Also:

Constant Field Values

PNG_MIME_TYPE

public static final String PNG_MIME_TYPE

See Also:

Constant Field Values

JPG_MIME_TYPE

public static final String JPG_MIME_TYPE

See Also:

Constant Field Values

COLOR_TRANSPARENT

public static final Color COLOR_TRANSPARENT

TRACKING_PIXEL_BYTES

public static final byte[] TRACKING_PIXEL_BYTES

Byte array of a tracking pixel image in gif format

TRACKING_PIXEL_BASE64

public static final String TRACKING_PIXEL_BASE64

Base64 string of a tracking pixel image in gif format

Method Detail

values

public static Img[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Img c : Img.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Img valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

source

public static Img._Load source(InputStream is)

source

public static Img._Load source(URL url)

source

public static Img._Load source(File file)

source

public static Img._Load source(Lang.Func0<BufferedImage> imageProducer)

source

public static Img._Load source(BufferedImage image)

resize

public static Img.Resizer.Stage resize(Lang.Func0<BufferedImage> imageProvider)

crop

public static Img.Cropper.Stage crop(Lang.Func0<BufferedImage> imageProvider)

flip

public static Img.Flip.Stage flip(Lang.Func0<BufferedImage> imageProvider)

blur

public static Img.Blur.Stage blur(Lang.Func0<BufferedImage> imageProvider)

watermark

public static Img.TextWriter.Stage watermark(Lang.Func0<BufferedImage> imageProvider)

concat

public static Img.Concatenater.Stage concat(Lang.Func0<BufferedImage> image1)

concat

public static Img.Concatenater.Stage concat(Lang.Func0<BufferedImage> image1,
                                            Lang.Func0<BufferedImage> image2)

toBase64

public static String toBase64(File image)

Encode an image to base64 using a data: URI

Parameters:

image - The image file

Returns:

The base64 encoded value

toBase64

public static String toBase64(InputStream inputStream,
                              String mimeType)

Encode an image to base64 using a data: URI

Parameters:

inputStream - The image input stream

mimeType - The mime type, if not specified then default to DEF_MIME_TYPE

Returns:

The base64 encoded value

toBase64

public static String toBase64(byte[] bytes,
                              String mimeType)

Encode an image to base64 using a data: URI

Parameters:

bytes - The image byte array

mimeType - the mime type, if not specified then default to DEF_MIME_TYPE

Returns:

The base64 encoded value

os

public static ImageOutputStream os(File file)

os

public static ImageOutputStream os(OutputStream os)

read

public static BufferedImage read(InputStream is)

read

public static BufferedImage read(File file)

read

public static BufferedImage read(URL url)