Package de.xima.fc.common.image

Class ImageThumbnailGeneratorConstraints

java.lang.Object

de.xima.fc.common.image.ImageThumbnailGeneratorConstraints

All Implemented Interfaces:

Serializable

public final class ImageThumbnailGeneratorConstraints
extends Object
implements Serializable

Constraints for generating image thumbnails, see IImageThumbnailGenerator.

Since:

8.3.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageThumbnailGeneratorConstraints.Builder	A builder for ImageThumbnailGeneratorConstraints.

Method Summary

Modifier and Type	Method	Description
static ImageThumbnailGeneratorConstraints.Builder	builder()	Creates a new builder for ImageThumbnailGeneratorConstraints.
boolean	equals(Object o)
int	hashCode()
static ImageThumbnailGeneratorConstraints	none()	Gets a ImageThumbnailGeneratorConstraints object with no constraints.
static ImageThumbnailGeneratorConstraints	ofCanonicalRepresentation(String canonicalRepresentation)	Parses a canonical representation of constraints into a ImageThumbnailGeneratorConstraints object.
static ImageThumbnailGeneratorConstraints	ofCanonicalRepresentationOrNull(String canonicalRepresentation)	Parses a canonical representation of constraints into a ImageThumbnailGeneratorConstraints object.
Integer	targetHeight()	Gets the constraint on the target height for the thumbnail.
Integer	targetWidth()	Gets the constraint on the target width for the thumbnail.
String	toCanonicalRepresentation()	Gets the canonical string representation of this constraints set.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

targetHeight

public Integer targetHeight()

Gets the constraint on the target height for the thumbnail.

Returns:

The target height in pixels, or null if no constraint is set.

targetWidth

public Integer targetWidth()

Gets the constraint on the target width for the thumbnail.

Returns:

The target width in pixels, or null if no constraint is set.

toCanonicalRepresentation

public String toCanonicalRepresentation()

Gets the canonical string representation of this constraints set. This is compatible with equals, i.e. two constraints sets that are Object.equals(Object) have the same canonical representation. The canonical string representation can be parsed by ofCanonicalRepresentation(String).

Returns:

The canonical representation.

toString

public String toString()

Overrides:

toString in class Object

builder

public static ImageThumbnailGeneratorConstraints.Builder builder()

Creates a new builder for ImageThumbnailGeneratorConstraints.

Returns:

The new builder.

none

public static ImageThumbnailGeneratorConstraints none()

Gets a ImageThumbnailGeneratorConstraints object with no constraints.

Returns:

An object representing no constraints.

ofCanonicalRepresentation

public static ImageThumbnailGeneratorConstraints ofCanonicalRepresentation(String canonicalRepresentation)

Parses a canonical representation of constraints into a ImageThumbnailGeneratorConstraints object.

Parameters:

canonicalRepresentation - The canonical representation.

Returns:

The constraints object, or none() if the string is empty, or null if the string is or null.

Throws:

IllegalArgumentException - If the canonical representation is invalid.

ofCanonicalRepresentationOrNull

public static ImageThumbnailGeneratorConstraints ofCanonicalRepresentationOrNull(String canonicalRepresentation)

Parses a canonical representation of constraints into a ImageThumbnailGeneratorConstraints object.

Parameters:

canonicalRepresentation - The canonical representation.

Returns:

The constraints object, or null if the canonical representation is invalid.