Package com.microstrategy.web.app.utils.cache

Class ResourceCacheHint

java.lang.Object

com.microstrategy.utils.cache.SimpleHint

com.microstrategy.web.app.utils.cache.ResourceCacheHint

All Implemented Interfaces:

CacheHint

public class ResourceCacheHint
extends SimpleHint

This class is the hint for ResourceCache. The ResourceCache requires the path to the file and its encoding (if any).

Since:

MicroStrategy Web 7.5.1

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	_encode	Deprecated. This instance variable should always be accessed through the getEncode() method
protected java.lang.String	_localeID	Deprecated. This variable is not internally used.

Fields inherited from interface com.microstrategy.utils.cache.CacheHint

ZERO_STATE_ID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ResourceCacheHint(java.lang.String path)	Initializes a new ResourceCacheHint with no file encoding.
protected	ResourceCacheHint(java.lang.String path, java.lang.String encoding)	Initializes a new ResourceCacheHint
protected	ResourceCacheHint(java.lang.String path, java.lang.String encoding, java.lang.String localeID)	Deprecated. use ResourceCacheHint(path, encoding)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.String	getEncode()	Returns the encoding that should be used to load the corresponding file.
protected java.lang.String	getPath()	Returns the path to the corresponding file.
int	hashCode()

Methods inherited from class com.microstrategy.utils.cache.SimpleHint

getCacheStateId, getCacheStates, getHint, getState, restoreState, setCacheStateId, setHint, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_encode

@Deprecated
protected java.lang.String _encode

Deprecated.

This instance variable should always be accessed through the getEncode() method

Identifies the file encoding for the corresponding resource

_localeID

@Deprecated
protected java.lang.String _localeID

Deprecated.

This variable is not internally used.

Identifies the locale for the corresponding resource

Constructor Detail

ResourceCacheHint

protected ResourceCacheHint(java.lang.String path,
                            java.lang.String encoding)

Initializes a new ResourceCacheHint

Parameters:

path - The location of the Resource. This location will be resolved by the FileLoader

encoding - The encoding to use to load the corresonding file. It can be null or empty string.

Since:

MicroStrategy Web 9.0.0

ResourceCacheHint

@Deprecated
protected ResourceCacheHint(java.lang.String path,
                            java.lang.String encoding,
                            java.lang.String localeID)

Deprecated.

use ResourceCacheHint(path, encoding)

Creates a new ResourceCacheHint with the given parameters. This constructor has been deprecated as locale is not internally used.

ResourceCacheHint

protected ResourceCacheHint(java.lang.String path)

Initializes a new ResourceCacheHint with no file encoding.

Parameters:

path - The location of the Resource. This location will be resolved by the FileLoader

Method Detail

getPath

protected java.lang.String getPath()

Returns the path to the corresponding file.

Since:

MicroStrategy Web 9.0.0

getEncode

public java.lang.String getEncode()

Returns the encoding that should be used to load the corresponding file.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class SimpleHint

Since:

MicroStrategy Web 9.0.1

hashCode

public int hashCode()

Overrides:

hashCode in class SimpleHint

Since:

MicroStrategy Web 9.0.1