org.netbeans.core.startup.layers

Class LayerCacheManager

java.lang.Object

org.netbeans.core.startup.layers.LayerCacheManager

All Implemented Interfaces:

org.netbeans.core.startup.base.LayerFactory

public abstract class LayerCacheManager
extends Object
implements org.netbeans.core.startup.base.LayerFactory

Interface for a manager which can handle XML layer caching.

See Also:

"#20168"

Nested Class Summary

Nested classes/interfaces inherited from interface org.netbeans.core.startup.base.LayerFactory

org.netbeans.core.startup.base.LayerFactory.Provider

Method Summary

Modifier and Type	Method and Description
List<URL>	additionalLayers(List<URL> urls) Provides additiona layers to be configured for the target FileSystem
static LayerCacheManager	create(String cacheLocation) Creates new cache manager for given cache location.
abstract FileSystem	createEmptyFileSystem() Create an empty cache filesystem, i.e.
abstract FileSystem	load(FileSystem previous, ByteBuffer bb) Load the cache from disk.
FileSystem	loadCache() Loads the filesystem from cache if cache is available.
static LayerCacheManager	manager(boolean real) Get a cache manager which does nothing.
FileSystem	store(FileSystem fs, List<URL> urls)
abstract void	store(FileSystem fs, List<URL> urls, OutputStream os) Save a new cache to disk, load it, and return that filesystem.

Methods inherited from class java.lang.Object

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

Method Detail

manager

public static LayerCacheManager manager(boolean real)

Get a cache manager which does nothing.

create

public static LayerCacheManager create(String cacheLocation)

Creates new cache manager for given cache location. The location shall be unique file name.

Parameters:

cacheLocation - unique file name

Returns:

cache manager

loadCache

public final FileSystem loadCache()
                           throws IOException

Loads the filesystem from cache if cache is available.

Specified by:

loadCache in interface org.netbeans.core.startup.base.LayerFactory

Returns:

the file system read or null, if the cache is out of date

Throws:

IOException - if an I/O error occurs

store

public final FileSystem store(FileSystem fs,
                              List<URL> urls)
                       throws IOException

Specified by:

store in interface org.netbeans.core.startup.base.LayerFactory

Throws:

IOException

additionalLayers

public List<URL> additionalLayers(List<URL> urls)

Provides additiona layers to be configured for the target FileSystem

Specified by:

additionalLayers in interface org.netbeans.core.startup.base.LayerFactory

Parameters:

urls - initial set of URLs

Returns:

modified set of URLs to create a filesystem with.

Since:

1.60

createEmptyFileSystem

public abstract FileSystem createEmptyFileSystem()
                                          throws IOException

Create an empty cache filesystem, i.e. with no initial layers. Should only be called when the cache directory is clean. Should not be overridden if the manager does not support loading; otherwise must be overridden.

Specified by:

createEmptyFileSystem in interface org.netbeans.core.startup.base.LayerFactory

Throws:

IOException

load

public abstract FileSystem load(FileSystem previous,
                                ByteBuffer bb)
                         throws IOException

Load the cache from disk. Should only be called when the cache directory is prepared. The filesystem's contents should be modified. The filesystem must have been originally produced by LayerCacheManager.createEmptyFileSystem() or #createLoadedFileSystem. Not called if the manager does not support loading; otherwise must be overridden.

Throws:

IOException

store

public abstract void store(FileSystem fs,
                           List<URL> urls,
                           OutputStream os)
                    throws IOException

Save a new cache to disk, load it, and return that filesystem.

Parameters:

urls - list of type URL; earlier layers can override later layers

Throws:

IOException