wicket.util.resource
Interface IResourceStream

All Superinterfaces:
IModifiable, java.io.Serializable
All Known Subinterfaces:
IStringResourceStream
All Known Implementing Classes:
AbstractResourceStream, AbstractStringResourceStream, FileResourceStream, MarkupResourceStream, StringBufferResourceStream, StringResourceStream, UrlResourceStream

public interface IResourceStream
extends IModifiable, java.io.Serializable

Interface to a streamed resource. The resource stream can be retrieved by calling getInputStream(), but the resource should later be closed by calling close() on the IResourceStream (as opposed to calling close on the InputStream returned by getInputStream()).

Once a resource has been closed with a call to close(), it is normally possible to call getInputStream() again to retrieve a new input stream on the same resource.

Implementations of this interface are typically unsafe for use from multiple threads.

Author:
Jonathan Locke

Method Summary
 void close()
          Closes the resource.
 java.lang.String getContentType()
          Gets the mime type of this resource
 java.io.InputStream getInputStream()
          Gets the resource stream.
 java.util.Locale getLocale()
           
 long length()
          Gets the size of this resource
 void setLocale(java.util.Locale locale)
          This method shouldn't be used for the outside, It is used by the Loaders to set the resolved locale.
 
Methods inherited from interface wicket.util.watch.IModifiable
lastModifiedTime
 

Method Detail

getContentType

java.lang.String getContentType()
Gets the mime type of this resource

Returns:
The mime type of this resource, such as "image/jpeg" or "text/html"

length

long length()
Gets the size of this resource

Returns:
The size of this resource in the number of bytes

getInputStream

java.io.InputStream getInputStream()
                                   throws ResourceStreamNotFoundException
Gets the resource stream. You should not directly close this stream. Instead call the close() method on IResourceStream.

Returns:
Returns the inputStream.
Throws:
ResourceStreamNotFoundException
See Also:
close()

close

void close()
           throws java.io.IOException
Closes the resource. Normally, this includes closing any underlying input stream returned by getInputStream().

Throws:
java.io.IOException

getLocale

java.util.Locale getLocale()
Returns:
The Locale where this stream did resolve to

setLocale

void setLocale(java.util.Locale locale)
This method shouldn't be used for the outside, It is used by the Loaders to set the resolved locale.

Parameters:
locale - The Locale where this stream did resolve to.


Copyright © 2004-2007 Wicket developers. All Rights Reserved.