org.apache.wicket.util.resource
Class AbstractStringResourceStream

java.lang.Object
  extended by org.apache.wicket.util.resource.AbstractResourceStream
      extended by org.apache.wicket.util.resource.AbstractStringResourceStream
All Implemented Interfaces:
java.io.Closeable, java.io.Serializable, IClusterable, IResourceStream, IStringResourceStream, IModifiable
Direct Known Subclasses:
StringBufferResourceStream, StringResourceStream, TextTemplate

public abstract class AbstractStringResourceStream
extends AbstractResourceStream
implements IStringResourceStream

Base class for string resources.

Author:
Jonathan Locke
See Also:
Serialized Form

Field Summary
static java.lang.String DEFAULT_CONTENT_TYPE
          The content-type applied in case the resource stream's default constructor is used
 
Constructor Summary
AbstractStringResourceStream()
          Constructor.
AbstractStringResourceStream(java.lang.String contentType)
          Constructor.
 
Method Summary
 java.lang.String asString()
           
 void close()
          Closes the resource.
protected  java.nio.charset.Charset getCharset()
           
 java.lang.String getContentType()
          Gets the mime type of this resource
 java.io.InputStream getInputStream()
          Gets the resource stream.
protected abstract  java.lang.String getString()
           
 Time lastModifiedTime()
          Gets the last time this modifiable thing changed.
 Bytes length()
          Gets the size of this resource
 void setCharset(java.nio.charset.Charset charset)
          Sets the character set used for reading this resource.
 void setLastModified(Time lastModified)
           
 
Methods inherited from class org.apache.wicket.util.resource.AbstractResourceStream
getLocale, getStyle, getVariation, setLocale, setStyle, setVariation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.wicket.util.resource.IResourceStream
getLocale, getStyle, getVariation, setLocale, setStyle, setVariation
 

Field Detail

DEFAULT_CONTENT_TYPE

public static final java.lang.String DEFAULT_CONTENT_TYPE
The content-type applied in case the resource stream's default constructor is used

See Also:
Constant Field Values
Constructor Detail

AbstractStringResourceStream

public AbstractStringResourceStream()
Constructor.


AbstractStringResourceStream

public AbstractStringResourceStream(java.lang.String contentType)
Constructor.

Parameters:
contentType - The mime type of this resource, such as "image/jpeg" or "text/html"
Method Detail

asString

public java.lang.String asString()
Specified by:
asString in interface IStringResourceStream
Returns:
This resource as a String.

getCharset

protected java.nio.charset.Charset getCharset()
Returns:
Charset for resource

setCharset

public void setCharset(java.nio.charset.Charset charset)
Sets the character set used for reading this resource.

Specified by:
setCharset in interface IStringResourceStream
Parameters:
charset - Charset for component

close

public void close()
           throws java.io.IOException
Description copied from interface: IResourceStream
Closes the resource. Normally, this includes closing any underlying input stream returned by getInputStream().

Specified by:
close in interface java.io.Closeable
Specified by:
close in interface IResourceStream
Throws:
java.io.IOException
See Also:
IResourceStream.close()

getContentType

public java.lang.String getContentType()
Description copied from interface: IResourceStream
Gets the mime type of this resource

Specified by:
getContentType in interface IResourceStream
Overrides:
getContentType in class AbstractResourceStream
Returns:
The mime type of this resource, such as "image/jpeg" or "text/html". Return null to let ResourceStreamRequestHandler handle the Content-Type automatically
See Also:
IResourceStream.getContentType()

getInputStream

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

Specified by:
getInputStream in interface IResourceStream
Returns:
Returns the inputStream.
Throws:
ResourceStreamNotFoundException
See Also:
IResourceStream.getInputStream()

lastModifiedTime

public Time lastModifiedTime()
Description copied from interface: IModifiable
Gets the last time this modifiable thing changed.

Specified by:
lastModifiedTime in interface IModifiable
Overrides:
lastModifiedTime in class AbstractResourceStream
Returns:
the last modification Time or null if that information is not available
See Also:
IModifiable.lastModifiedTime()

setLastModified

public void setLastModified(Time lastModified)
Parameters:
lastModified - The lastModified to set.

getString

protected abstract java.lang.String getString()
Returns:
The string resource

length

public final Bytes length()
Description copied from interface: IResourceStream
Gets the size of this resource

Specified by:
length in interface IResourceStream
Overrides:
length in class AbstractResourceStream
Returns:
The size of this resource in the number of bytes, or null if unknown


Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.