com.uploadcare.urls

Class CdnPathBuilder

java.lang.Object

com.uploadcare.urls.CdnPathBuilder

public class CdnPathBuilder
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CdnPathBuilder.ImageFormat
static class	CdnPathBuilder.ImageQuality

Constructor Summary

Constructors

Constructor and Description
CdnPathBuilder(File file) Creates a new CDN path builder for some image file.

Method Summary

Modifier and Type	Method and Description
CdnPathBuilder	blur() Performs Gaussian blur on result image.
CdnPathBuilder	blur(int strength) Performs Gaussian blur on result image.
java.lang.String	build() Returns the current CDN path as a string.
CdnPathBuilder	crop(int width, int height) Adds top-left-aligned crop.
CdnPathBuilder	cropCenter(int width, int height) Adds center-aligned crop.
CdnPathBuilder	cropCenterColor(int width, int height, java.awt.Color color) Adds center-aligned crop with a filled background.
CdnPathBuilder	cropColor(int width, int height, java.awt.Color color) Adds top-left-aligned crop with a filled background.
CdnPathBuilder	flip() Flips the image.
CdnPathBuilder	format(CdnPathBuilder.ImageFormat format) Turn an image to one of the following formats: FORMAT_JPEG or FORMAT_PNG.
CdnPathBuilder	grayscale() Adds a grayscale effect.
CdnPathBuilder	invert() Inverts colors.
CdnPathBuilder	mirror() Horizontally mirror image.
CdnPathBuilder	preview(int width, int height) Reduces an image proportionally in order to fit it into given dimensions.
CdnPathBuilder	quality(CdnPathBuilder.ImageQuality quality) Image quality affects size of image and loading speed.
CdnPathBuilder	resize(int width, int height) Resizes width and height
CdnPathBuilder	resizeHeight(int height) Resizes height, keeping the aspect ratio.
CdnPathBuilder	resizeWidth(int width) Resizes width, keeping the aspect ratio.
CdnPathBuilder	scaleCrop(int width, int height) Scales the image until one of the dimensions fits, then crops the bottom or right side.
CdnPathBuilder	scaleCropCenter(int width, int height) Scales the image until one of the dimensions fits, centers it, then crops the rest.
CdnPathBuilder	sharp() Performs sharpening on result image.
CdnPathBuilder	sharp(int strength) Performs sharpening on result image.

Methods inherited from class java.lang.Object

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

Constructor Detail

CdnPathBuilder

public CdnPathBuilder(File file)

Creates a new CDN path builder for some image file.

Parameters:

file - File to be used for the path

See Also:

File.cdnPath()

Method Detail

crop

public CdnPathBuilder crop(int width,
                           int height)

Adds top-left-aligned crop.

Parameters:

width - Crop width

height - Crop height

cropCenter

public CdnPathBuilder cropCenter(int width,
                                 int height)

Adds center-aligned crop.

Parameters:

width - Crop width

height - Crop height

cropColor

public CdnPathBuilder cropColor(int width,
                                int height,
                                java.awt.Color color)

Adds top-left-aligned crop with a filled background.

Parameters:

width - Crop width

height - Crop height

color - Background color

cropCenterColor

public CdnPathBuilder cropCenterColor(int width,
                                      int height,
                                      java.awt.Color color)

Adds center-aligned crop with a filled background.

Parameters:

width - Crop width

height - Crop height

color - Background color

resizeWidth

public CdnPathBuilder resizeWidth(int width)

Resizes width, keeping the aspect ratio.

Parameters:

width - New width

resizeHeight

public CdnPathBuilder resizeHeight(int height)

Resizes height, keeping the aspect ratio.

Parameters:

height - New height

resize

public CdnPathBuilder resize(int width,
                             int height)

Resizes width and height

Parameters:

width - New width

height - New height

scaleCrop

public CdnPathBuilder scaleCrop(int width,
                                int height)

Scales the image until one of the dimensions fits, then crops the bottom or right side.

Parameters:

width - New width

height - New height

scaleCropCenter

public CdnPathBuilder scaleCropCenter(int width,
                                      int height)

Scales the image until one of the dimensions fits, centers it, then crops the rest.

Parameters:

width - New width

height - New height

flip

public CdnPathBuilder flip()

Flips the image.

grayscale

public CdnPathBuilder grayscale()

Adds a grayscale effect.

invert

public CdnPathBuilder invert()

Inverts colors.

mirror

public CdnPathBuilder mirror()

Horizontally mirror image.

blur

public CdnPathBuilder blur()

Performs Gaussian blur on result image.

blur

public CdnPathBuilder blur(int strength)

Performs Gaussian blur on result image.

Parameters:

strength - Strength is standard deviation (aka blur radius) multiplied by ten. Strength can be up to 5000. Default is 10.

sharp

public CdnPathBuilder sharp()

Performs sharpening on result image. This can be useful after scaling down.

sharp

public CdnPathBuilder sharp(int strength)

Performs sharpening on result image. This can be useful after scaling down.

Parameters:

strength - Strength can be from 0 to 20. Default is 5.

preview

public CdnPathBuilder preview(int width,
                              int height)

Reduces an image proportionally in order to fit it into given dimensions.

Parameters:

width - New width

height - New height

format

public CdnPathBuilder format(CdnPathBuilder.ImageFormat format)

Turn an image to one of the following formats: FORMAT_JPEG or FORMAT_PNG.

Parameters:

format - @link ImageFormat.

quality

public CdnPathBuilder quality(CdnPathBuilder.ImageQuality quality)

Image quality affects size of image and loading speed. Has no effect on non-JPEG images, but does not force format to JPEG.

Parameters:

quality - @link ImageQuality QUALITY_NORMAL – used by default. Fine in most cases. QUALITY_BETTER – can be used on relatively small previews with lots of details. ≈125% file size compared to normal image. QUALITY_BEST – useful if you're a photography god and you want to get perfect quality without paying attention to size. ≈170% file size. QUALITY_LIGHTER – can be used on relatively large images to save traffic without significant quality loss. ≈80% file size. QUALITY_LIGHTEST — useful for retina resolutions, when you don't wory about quality of each pixel. ≈50% file size.

build

public java.lang.String build()

Returns the current CDN path as a string. Avoid using directly. Instead, pass the configured builder to a URL factory.

Returns:

CDN path

See Also:

Urls.cdn(CdnPathBuilder)