org.apache.flex.compiler.internal.caches

Class CSSDocumentCache

java.lang.Object

org.apache.flex.compiler.internal.caches.ConcurrentCacheStoreBase<ICSSDocument>

org.apache.flex.compiler.internal.caches.CSSDocumentCache

public class CSSDocumentCache
extends ConcurrentCacheStoreBase<ICSSDocument>

Cache for ICSSDocument at workspace level. The CSS model can be a "defaults.css" file inside a SWC library, or a CSS file on the disk.

The cache key is normalized path to the SWC file (optional) and the CSS file name inside the SWC. The cache value is an ICSSDocument.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CSSDocumentCache.CSSDocumentCacheKey Key object for CSSDocumentCache.
protected static class	CSSDocumentCache.CSSDocumentCacheKey2 Key object for CSSDocumentCache.
static class	CSSDocumentCache.ProblemParsingCSSRuntimeException Since ConcurrentCacheStoreBase.get(org.apache.flex.compiler.internal.caches.CacheStoreKeyBase) doesn't return compiler problems, when there's problem parsing CSS file in createEntryValue(org.apache.flex.compiler.internal.caches.CacheStoreKeyBase), we have to throw a runtime exception to pass the compiler problems to the caller of the cache store.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	ALL_DEFAULTS_CSS_FILENAMES
static ICSSDocument	EMPTY_CSS_DOCUMENT Since ConcurrentCacheStoreBase does not allow null values, when a SWC library does not have a "defaults.css" file, this dummy value is used.

Constructor Summary

Constructors

Constructor and Description
CSSDocumentCache()

Method Summary

Methods

Modifier and Type	Method and Description
protected ICSSDocument	createEntryValue(CacheStoreKeyBase key) Concrete class must implement this method to create a cache value object.
static CacheStoreKeyBase	createKey(ISWC swc, String cssFileName) Create a cache key for CSSDocumentCache that references a CSS file in a SWC.
static CacheStoreKeyBase	createKey(String cssFileName) Create a cache key for CSSDocumentCache that references a CSS file on disk.
ICSSDocument	getDefaultsCSS(ISWC swc, Integer compatibilityVersion) Get the "default" CSS model in a SWC library.

Methods inherited from class org.apache.flex.compiler.internal.caches.ConcurrentCacheStoreBase

get, remove, size, toString

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_CSS_DOCUMENT

public static final ICSSDocument EMPTY_CSS_DOCUMENT

Since ConcurrentCacheStoreBase does not allow null values, when a SWC library does not have a "defaults.css" file, this dummy value is used.

ALL_DEFAULTS_CSS_FILENAMES

public static String[] ALL_DEFAULTS_CSS_FILENAMES

Constructor Detail

CSSDocumentCache

public CSSDocumentCache()

Method Detail

createKey

public static CacheStoreKeyBase createKey(ISWC swc,
                          String cssFileName)

Create a cache key for CSSDocumentCache that references a CSS file in a SWC.

Parameters:

swc - SWC file

cssFileName - CSS file name

Returns:

Key for CSSDocumentCache.

createKey

public static CacheStoreKeyBase createKey(String cssFileName)

Create a cache key for CSSDocumentCache that references a CSS file on disk.

Parameters:

cssFileName - CSS file name

Returns:

Key for CSSDocumentCache.

createEntryValue

protected ICSSDocument createEntryValue(CacheStoreKeyBase key)

Description copied from class: ConcurrentCacheStoreBase

Concrete class must implement this method to create a cache value object. Do NOT add the value to the cache in this method. ConcurrentCacheStoreBase.get(CacheStoreKeyBase) is responsible for reading and writing the cache table.

Specified by:

createEntryValue in class ConcurrentCacheStoreBase<ICSSDocument>

Parameters:

key - cache key

Returns:

object to be cached.

getDefaultsCSS

public ICSSDocument getDefaultsCSS(ISWC swc,
                          Integer compatibilityVersion)

Get the "default" CSS model in a SWC library. If compatibility-version=3 is set, this method will try to get "defaults-3.0.0.css" first. If the compatibility version isn't present, it will fall back to "defaults.css".

Parameters:

swc - SWC file.

compatibilityVersion - Compatibility version, or null if the compiler is not under compatibility mode.

Returns:

"defaults" CSS model or null if not found