com.vaadin.terminal
Class ClassResource

java.lang.Object
  com.vaadin.terminal.ClassResource

All Implemented Interfaces:

ApplicationResource, Resource, Serializable

public class ClassResource
extends Object
implements ApplicationResource, Serializable

ClassResource is a named resource accessed with the class loader. This can be used to access resources such as icons, files, etc.

Since:

3.0

Version:

6.8.18

Author:

Vaadin Ltd.

See Also:

Class.getResource(java.lang.String), Serialized Form

Field Summary

Fields inherited from interface com.vaadin.terminal.ApplicationResource

DEFAULT_CACHETIME

Constructor Summary

ClassResource(Class<?> associatedClass, String resourceName, Application application)
Creates a new application resource instance.

ClassResource(String resourceName, Application application)
Creates a new application resource instance.

Method Summary

Application	getApplication() Gets the application of this resource.
int	getBufferSize() Gets the size of the download buffer used for this resource.
long	getCacheTime() Gets the length of cache expiration time.
String	getFilename() Gets the virtual filename for this resource.
String	getMIMEType() Gets the MIME type of this resource.
DownloadStream	getStream() Gets resource as stream.
void	setBufferSize(int bufferSize) Sets the size of the download buffer used for this resource.
void	setCacheTime(long cacheTime) Sets the length of cache expiration time.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassResource

public ClassResource(String resourceName,
                     Application application)

Creates a new application resource instance. The resource id is relative to the location of the application class.

Parameters:

resourceName - the Unique identifier of the resource within the application.

application - the application this resource will be added to.

ClassResource

public ClassResource(Class<?> associatedClass,
                     String resourceName,
                     Application application)

Creates a new application resource instance.

Parameters:

associatedClass - the class of the which the resource is associated.

resourceName - the Unique identifier of the resource within the application.

application - the application this resource will be added to.

Method Detail

getMIMEType

public String getMIMEType()

Gets the MIME type of this resource.

Specified by:

getMIMEType in interface Resource

Returns:

the MIME type of the resource.

See Also:

Resource.getMIMEType()

getApplication

public Application getApplication()

Gets the application of this resource.

Specified by:

getApplication in interface ApplicationResource

See Also:

ApplicationResource.getApplication()

getFilename

public String getFilename()

Gets the virtual filename for this resource.

Specified by:

getFilename in interface ApplicationResource

Returns:

the file name associated to this resource.

See Also:

ApplicationResource.getFilename()

getStream

public DownloadStream getStream()

Gets resource as stream.

Specified by:

getStream in interface ApplicationResource

See Also:

ApplicationResource.getStream()

getBufferSize

public int getBufferSize()

Description copied from interface: ApplicationResource

Gets the size of the download buffer used for this resource.

If the buffer size is 0, the buffer size is decided by the terminal adapter. The default value is 0.

Specified by:

getBufferSize in interface ApplicationResource

Returns:

int the size of the buffer in bytes.

setBufferSize

public void setBufferSize(int bufferSize)

Sets the size of the download buffer used for this resource.

Parameters:

bufferSize - the size of the buffer in bytes.

getCacheTime

public long getCacheTime()

Description copied from interface: ApplicationResource

Gets the length of cache expiration time.

This gives the adapter the possibility cache streams sent to the client. The caching may be made in adapter or at the client if the client supports caching. Default is DEFAULT_CACHETIME.

Specified by:

getCacheTime in interface ApplicationResource

Returns:

Cache time in milliseconds

setCacheTime

public void setCacheTime(long cacheTime)

Sets the length of cache expiration time.

This gives the adapter the possibility cache streams sent to the client. The caching may be made in adapter or at the client if the client supports caching. Zero or negavive value disbales the caching of this stream.

Parameters:

cacheTime - the cache time in milliseconds.