org.apache.wicket.markup
Class MarkupResourceStream

java.lang.Object
  org.apache.wicket.markup.MarkupResourceStream

All Implemented Interfaces:

java.io.Closeable, java.io.Serializable, IClusterable, IFixedLocationResourceStream, IResourceStream, IModifiable

public class MarkupResourceStream
extends java.lang.Object
implements IResourceStream, IFixedLocationResourceStream

An IResourceStream implementation with specific extensions for markup resource streams.

Author:

Juergen Donnerstag

See Also:

Serialized Form

Constructor Summary

MarkupResourceStream(IResourceStream resourceStream)
Construct.

MarkupResourceStream(IResourceStream resourceStream, ContainerInfo containerInfo, java.lang.Class<?> markupClass)
Construct.

Method Summary

void	close() Closes the resource.
java.lang.String	getCacheKey() Gets cacheKey.
ContainerInfo	getContainerInfo() Get the container info associated with the markup
java.lang.String	getContentType() Gets the mime type of this resource
java.io.InputStream	getInputStream() Gets the resource stream.
java.util.Locale	getLocale()
java.lang.Class<? extends Component>	getMarkupClass() Get the actual component class the markup is directly associated with.
Time	lastModifiedTime() Gets the last time this modifiable thing changed.
long	length() Gets the size of this resource in bytes TODO 1.5: rename to lengthInBytes() or let it return some sort of size object
java.lang.String	locationAsString()
void	setCacheKey(java.lang.String cacheKey) Set the cache key
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MarkupResourceStream

public MarkupResourceStream(IResourceStream resourceStream)

Construct.

Parameters:

resourceStream -

MarkupResourceStream

public MarkupResourceStream(IResourceStream resourceStream,
                            ContainerInfo containerInfo,
                            java.lang.Class<?> markupClass)

Construct.

Parameters:

resourceStream -

containerInfo -

markupClass -

Method Detail

locationAsString

public java.lang.String locationAsString()

Specified by:

locationAsString in interface IFixedLocationResourceStream

Returns:

The fixed location as a string, e.g. the file name or the URL

See Also:

IFixedLocationResourceStream.locationAsString()

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

Returns:

The mime type of this resource, such as "image/jpeg" or "text/html". Return null to let ResourceStreamRequestTarget 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()

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface IResourceStream

Returns:

The Locale where this stream did resolve to

See Also:

IResourceStream.getLocale()

lastModifiedTime

public Time lastModifiedTime()

Description copied from interface: IModifiable

Gets the last time this modifiable thing changed.

Specified by:

lastModifiedTime in interface IModifiable

Returns:

the last modification Time

See Also:

IModifiable.lastModifiedTime()

length

public long length()

Description copied from interface: IResourceStream

Gets the size of this resource in bytes TODO 1.5: rename to lengthInBytes() or let it return some sort of size object

Specified by:

length in interface IResourceStream

Returns:

The size of this resource in the number of bytes, or -1 if unknown

See Also:

IResourceStream.length()

setLocale

public void setLocale(java.util.Locale locale)

Description copied from interface: IResourceStream

This method shouldn't be used for the outside, It is used by the Loaders to set the resolved locale.

Specified by:

setLocale in interface IResourceStream

Parameters:

locale - The Locale where this stream did resolve to.

See Also:

IResourceStream.setLocale(java.util.Locale)

getMarkupClass

public java.lang.Class<? extends Component> getMarkupClass()

Get the actual component class the markup is directly associated with. Note: it not necessarily must be the container class.

Returns:

The directly associated class

getContainerInfo

public ContainerInfo getContainerInfo()

Get the container info associated with the markup

Returns:

ContainerInfo

getCacheKey

public final java.lang.String getCacheKey()

Gets cacheKey.

Returns:

cacheKey

setCacheKey

public final void setCacheKey(java.lang.String cacheKey)

Set the cache key

Parameters:

cacheKey -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()