com.sdl.context.resource.api

Interface Resource

All Known Subinterfaces:

ClarifiedImage, FileResource, Image, UriImage, UriResource

All Known Implementing Classes:

AbstractImage, DefaultFileResource, FileImage, HttpImage, TransformedImage, UrlImage

public interface Resource

Generic resource object.

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Deprecated. use ByteString class instead.
ByteString	getByteString() Return the resource as a byte array's clone.
String	getContentType() Get the content content type of the resource, for example image/jpeg.
String	getExtension() Returns the normalised extension for this resource, e.g.
InputStream	getInputStream() Create an input stream for this resource.
long	getSize() Return size of the resource in bytes.

Method Detail

getInputStream

InputStream getInputStream()
                    throws IOException

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

Returns:

input stream

Throws:

IOException

getBytes

@Deprecated
byte[] getBytes()
                      throws IOException

Deprecated. use ByteString class instead.

Return the resource as a byte array.

Throws:

IOException

getByteString

ByteString getByteString()
                  throws IOException

Return the resource as a byte array's clone.

Throws:

IOException

getSize

long getSize()
      throws IOException

Return size of the resource in bytes.

Throws:

IOException

getContentType

String getContentType()

Get the content content type of the resource, for example image/jpeg.

getExtension

String getExtension()

Returns the normalised extension for this resource, e.g. a .jpg URI would return jpeg.

Returns:

extension