org.povclipse2.editors.processors

Class IncludeDeclarationStorage

java.lang.Object

org.povclipse2.editors.processors.IncludeDeclarationStorage

public class IncludeDeclarationStorage
extends java.lang.Object

Storage for caching Declaration entries for files.

Author:

Wolfgang Möstl

See Also:

gitweb

Method Summary

Modifier and Type	Method and Description
void	addDeclarationEntryIfNecessary(java.io.File file, DeclEntry entry) Adds a DeclEntry object to the IncludeDeclarationCacheEntry for the given file.
void	addIncludeEntryIfNecessary(java.io.File file, java.lang.String include) Adds an include file name to the IncludeDeclarationCacheEntry for the given file.
IncludeDeclarationCacheEntry	getDeclarationEntriesForFile(java.io.File file) Returns the IncludeDeclarationCacheEntry objects for the given file holding the sets of known DeclEntries and includes.
static IncludeDeclarationStorage	getInstance()
static boolean	isCacheActivated()
static void	loadSettingsFromPreferences() Updates the cache settings being used with the values defined by the preference store.

Methods inherited from class java.lang.Object

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

Method Detail

loadSettingsFromPreferences

public static void loadSettingsFromPreferences()

Updates the cache settings being used with the values defined by the preference store.

isCacheActivated

public static boolean isCacheActivated()

Returns:

true if the cache is activated (that is, CACHE_RELOAD_TIME is set to a value bigger than zero), false otherwise.

getInstance

public static IncludeDeclarationStorage getInstance()

Returns:

The singeton-pattern class instance

getDeclarationEntriesForFile

public IncludeDeclarationCacheEntry getDeclarationEntriesForFile(java.io.File file)

Returns the IncludeDeclarationCacheEntry objects for the given file holding the sets of known DeclEntries and includes.

Parameters:

file - The File whose IncludeDeclarationCacheEntry is to be returned

Returns:

• NULL if the file was not processed yet or the file is opened in an editor
• A IncludeDeclarationCacheEntry object if the file was already processed.

addDeclarationEntryIfNecessary

public void addDeclarationEntryIfNecessary(java.io.File file,
                                           DeclEntry entry)

Adds a DeclEntry object to the IncludeDeclarationCacheEntry for the given file.

The DeclEntry is ***NOT*** added if:

• The file is opened in an editor (obviously Eclipse editors only!)

Parameters:

file - The file to receive the DeclEntry

entry - The DeclEntry to store.

addIncludeEntryIfNecessary

public void addIncludeEntryIfNecessary(java.io.File file,
                                       java.lang.String include)

Adds an include file name to the IncludeDeclarationCacheEntry for the given file.

The include file name is ***NOT*** added if:

• The file is opened in an editor (obviously Eclipse editors only!)

Parameters:

file - The file to receive the DeclEntry

include - The include file name to store.