com.sdl.context.image

Class UrlImage

java.lang.Object

com.sdl.context.image.AbstractImage

com.sdl.context.image.UrlImage

All Implemented Interfaces:

Image, UriImage, Resource, UriResource, Serializable

public class UrlImage
extends AbstractImage
implements UriImage

Image located at a URL. Note that this class is used in production to serve images from jar files with the primary use case of this being loading the error 1x1.gif image.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UrlImage(String urlAsString) Create a UrlImage from a urlString, this method is protected to force use of the ImageFactory.
protected	UrlImage(URL url) Create a UrlImage from a URL, this method is protected to force use of the ImageFactory.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
byte[]	getBytes() Return the resource as a byte array.
ByteString	getByteString() Return the resource as a byte array's clone.
InputStream	getInputStream() Create an input stream for this resource.
ResourceInfo	getResourceInfo()
long	getSize() Return size of the resource in bytes.
String	getUriAsString() Returns the uri (and hence a unique identifier) for a resource as a String.
URL	getUrl()
int	hashCode()
String	toString()

Methods inherited from class com.sdl.context.image.AbstractImage

getContentType, getExtension, setContentType, setExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sdl.context.resource.api.Resource

getContentType, getExtension

Constructor Detail

UrlImage

protected UrlImage(String urlAsString)
            throws URISyntaxException,
                   MalformedURLException

Create a UrlImage from a urlString, this method is protected to force use of the ImageFactory.

Parameters:

urlAsString - the URL as a String, e.g. "http://localhost:8080/images/mygif.gif"

Throws:

URISyntaxException

MalformedURLException

UrlImage

protected UrlImage(URL url)
            throws URISyntaxException

Create a UrlImage from a URL, this method is protected to force use of the ImageFactory.

Parameters:

url - the URL

Throws:

URISyntaxException

Method Detail

getUrl

public URL getUrl()

getSize

public long getSize()
             throws IOException

Description copied from interface: Resource

Return size of the resource in bytes.

Specified by:

getSize in interface Resource

Throws:

IOException

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: Resource

Create an input stream for this resource. Note that the caller of this method is responsible for closing the input stream.

Specified by:

getInputStream in interface Resource

Returns:

input stream

Throws:

IOException

getBytes

public byte[] getBytes()
                throws IOException

Description copied from interface: Resource

Return the resource as a byte array.

Specified by:

getBytes in interface Resource

Throws:

IOException

getByteString

public ByteString getByteString()
                         throws IOException

Description copied from interface: Resource

Return the resource as a byte array's clone.

Specified by:

getByteString in interface Resource

Throws:

IOException

getUriAsString

public String getUriAsString()

Description copied from interface: UriResource

Returns the uri (and hence a unique identifier) for a resource as a String.

Specified by:

getUriAsString in interface UriResource

Returns:

the resource URI as a string

getResourceInfo

public ResourceInfo getResourceInfo()

Specified by:

getResourceInfo in interface UriImage

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object