Resource (bboss-velocity 6.1.5 API)

java.lang.Object
- bboss.org.apache.velocity.runtime.resource.Resource

直接已知子类:

ContentResource, Template
```
public abstract class Resource
extends java.lang.Object
```
This class represent a general text resource that may have been retrieved from any number of possible sources.

字段概要

字段
限定符和类型	字段和说明
`protected java.lang.Object`	`data` Resource might require ancillary storage of some kind
`protected java.lang.String`	`encoding` Character encoding of this resource
`protected long`	`lastModified` The file modification time (in milliseconds) for the cached template.
`protected static long`	`MILLIS_PER_SECOND` The number of milliseconds in a minute, used to calculate the check interval.
`protected long`	`modificationCheckInterval` How often the file modification time is checked (in seconds).
`protected java.lang.String`	`name` Name of the resource
`protected long`	`nextCheck` The next time the file modification time will be checked (in milliseconds).
`protected ResourceLoader`	`resourceLoader` The template loader that initially loaded the input stream for this template, and knows how to check the source of the input stream for modification.
`protected RuntimeServices`	`rsvc`
`protected int`	`type` Resource type (RESOURCE_TEMPLATE or RESOURCE_CONTENT)

构造器概要

构造器
构造器和说明

Resource()
Default constructor

构造器
构造器和说明
`Resource()` Default constructor

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`java.lang.Object`	`getData()` Get arbitrary data object that might be used by the resource.
`java.lang.String`	`getEncoding()` get the encoding of this resource for example, "ISO-8859-1"
`long`	`getLastModified()` Return the lastModifed time of this resource.
`java.lang.String`	`getName()` Get the name of this template.
`ResourceLoader`	`getResourceLoader()` Return the template loader that pulled in the template stream
`int`	`getType()`
`boolean`	`isSourceModified()`
`abstract boolean`	`process()` Perform any subsequent processing that might need to be done by a resource.
`boolean`	`requiresChecking()` Is it time to check to see if the resource source has been updated?
`void`	`setData(java.lang.Object data)` Set arbitrary data object that might be used by the resource.
`void`	`setEncoding(java.lang.String encoding)` set the encoding of this resource for example, "ISO-8859-1"
`void`	`setLastModified(long lastModified)` Set the last modified time for this resource.
`void`	`setModificationCheckInterval(long modificationCheckInterval)` Set the modification check interval.
`void`	`setName(java.lang.String name)` Set the name of this resource, for example test.vm.
`void`	`setResourceLoader(ResourceLoader resourceLoader)` Set the template loader for this template.
`void`	`setRuntimeServices(RuntimeServices rs)`
`void`	`setType(int type)` Sets the type of this Resource (RESOURCE_TEMPLATE or RESOURCE_CONTENT)
`void`	`touch()` 'Touch' this template and thereby resetting the nextCheck field.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - rsvc
```
protected RuntimeServices rsvc
```
  - resourceLoader
```
protected ResourceLoader resourceLoader
```
    The template loader that initially loaded the input stream for this template, and knows how to check the source of the input stream for modification.
  - MILLIS_PER_SECOND
```
protected static final long MILLIS_PER_SECOND
```
    The number of milliseconds in a minute, used to calculate the check interval.
    
    另请参阅:
    
    常量字段值
  - modificationCheckInterval
```
protected long modificationCheckInterval
```
    How often the file modification time is checked (in seconds).
  - lastModified
```
protected long lastModified
```
    The file modification time (in milliseconds) for the cached template.
  - nextCheck
```
protected long nextCheck
```
    The next time the file modification time will be checked (in milliseconds).
  - name
```
protected java.lang.String name
```
    Name of the resource
  - encoding
```
protected java.lang.String encoding
```
    Character encoding of this resource
  - data
```
protected java.lang.Object data
```
    Resource might require ancillary storage of some kind
  - type
```
protected int type
```
    Resource type (RESOURCE_TEMPLATE or RESOURCE_CONTENT)
- 构造器详细资料
  - Resource
```
public Resource()
```
    Default constructor
- 方法详细资料
  - setRuntimeServices
```
public void setRuntimeServices(RuntimeServices rs)
```
    参数:
    
    rs -
  - process
```
public abstract boolean process()
                         throws ResourceNotFoundException,
                                ParseErrorException
```
    Perform any subsequent processing that might need to be done by a resource. In the case of a template the actual parsing of the input stream needs to be performed.
    
    返回:
    
    Whether the resource could be processed successfully. For a Template or ContentResource, this indicates whether the resource could be read.
    
    抛出:
    
    ResourceNotFoundException - Similar in semantics as returning false.
    
    ParseErrorException
  - isSourceModified
```
public boolean isSourceModified()
```
    返回:
    
    True if source has been modified.
  - setModificationCheckInterval
```
public void setModificationCheckInterval(long modificationCheckInterval)
```
    Set the modification check interval.
    
    参数:
    
    modificationCheckInterval - The interval (in seconds).
  - requiresChecking
```
public boolean requiresChecking()
```
    Is it time to check to see if the resource source has been updated?
    
    返回:
    
    True if resource must be checked.
  - touch
```
public void touch()
```
    'Touch' this template and thereby resetting the nextCheck field.
  - setName
```
public void setName(java.lang.String name)
```
    Set the name of this resource, for example test.vm.
    
    参数:
    
    name -
  - getName
```
public java.lang.String getName()
```
    Get the name of this template.
    
    返回:
    
    The name of this template.
  - setEncoding
```
public void setEncoding(java.lang.String encoding)
```
    set the encoding of this resource for example, "ISO-8859-1"
    
    参数:
    
    encoding -
  - getEncoding
```
public java.lang.String getEncoding()
```
    get the encoding of this resource for example, "ISO-8859-1"
    
    返回:
    
    The encoding of this resource.
  - getLastModified
```
public long getLastModified()
```
    Return the lastModifed time of this resource.
    
    返回:
    
    The lastModifed time of this resource.
  - setLastModified
```
public void setLastModified(long lastModified)
```
    Set the last modified time for this resource.
    
    参数:
    
    lastModified -
  - getResourceLoader
```
public ResourceLoader getResourceLoader()
```
    Return the template loader that pulled in the template stream
    
    返回:
    
    The resource loader for this resource.
  - setResourceLoader
```
public void setResourceLoader(ResourceLoader resourceLoader)
```
    Set the template loader for this template. Set when the Runtime determines where this template came from the list of possible sources.
    
    参数:
    
    resourceLoader -
  - setData
```
public void setData(java.lang.Object data)
```
    Set arbitrary data object that might be used by the resource.
    
    参数:
    
    data -
  - getData
```
public java.lang.Object getData()
```
    Get arbitrary data object that might be used by the resource.
    
    返回:
    
    The data object for this resource.
  - setType
```
public void setType(int type)
```
    Sets the type of this Resource (RESOURCE_TEMPLATE or RESOURCE_CONTENT)
    
    从以下版本开始:
    
    1.6
  - getType
```
public int getType()
```
    返回:
    
    type code of the Resource
    
    从以下版本开始:
    
    1.6

类 Resource

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

rsvc

resourceLoader

MILLIS_PER_SECOND

modificationCheckInterval

lastModified

nextCheck

name

encoding

data

type

构造器详细资料

Resource

方法详细资料

setRuntimeServices

process

isSourceModified

setModificationCheckInterval

requiresChecking

touch

setName

getName

setEncoding

getEncoding

getLastModified

setLastModified

getResourceLoader

setResourceLoader

setData

getData

setType

getType