Package com.attribyte.parser.model

Class Image

java.lang.Object

com.attribyte.parser.model.Image

public class Image
extends Object

An immutable image.

Author:

Matt Hamer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Image.Builder	Builds an immutable image.

Field Summary

Fields

Modifier and Type	Field	Description
final String	altText	Text that describes the image, or an empty string if none.
final String	credit	An image credit.
final Optional<com.google.protobuf.ByteString>	data	The image data (bytes), if available.
final int	height	The image height or 0 if unknown.
final String	id	A unique id, or an empty string if none.
final String	link	A link to the image.
final String	mediaType	The media type (for example, image/png), or an empty string if unknown.
final String	title	A title for the image, or an empty string if none.
final int	width	The image width or 0 if unknown.

Method Summary

Modifier and Type	Method	Description
static Image.Builder	builder(byte[] data)	Creates a builder for images with data.
static Image.Builder	builder(Image image)	Creates a builder from an existing image.
static Image.Builder	builder(String link)	Creates a builder for images with a link.
boolean	equals(Object o)
int	hashCode()
String	toString()
Image	withNewLink(String link)	Creates a copy of this image with a new link.

Methods inherited from class java.lang.Object

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

Field Details

id

public final String id

A unique id, or an empty string if none.

link

public final String link

A link to the image. Never null or empty.

altText

public final String altText

Text that describes the image, or an empty string if none.

title

public final String title

A title for the image, or an empty string if none.

credit

public final String credit

An image credit.

width

public final int width

The image width or 0 if unknown.

height

public final int height

The image height or 0 if unknown.

mediaType

public final String mediaType

The media type (for example, image/png), or an empty string if unknown.

data

public final Optional<com.google.protobuf.ByteString> data

The image data (bytes), if available.

Method Details

builder

public static Image.Builder builder(String link)
                             throws UnsupportedOperationException

Creates a builder for images with a link.

Parameters:

link - The link.

Returns:

The builder.

Throws:

UnsupportedOperationException - If the specified link is null or empty.

builder

public static Image.Builder builder(byte[] data)
                             throws UnsupportedOperationException

Creates a builder for images with data.

Parameters:

data - The data.

Returns:

The builder.

Throws:

UnsupportedOperationException - If the specified data is null or empty.

builder

public static Image.Builder builder(Image image)

Creates a builder from an existing image.

Parameters:

image - The image.

Returns:

The builder initialized from the existing image.

withNewLink

public Image withNewLink(String link)
                  throws UnsupportedOperationException

Creates a copy of this image with a new link.

Parameters:

link - The new link.

Returns:

The new image.

Throws:

UnsupportedOperationException - If the specified link is null or empty.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object