org.apache.flex.compiler.internal.scopes

Class EmptyDefinitionStore

java.lang.Object

org.apache.flex.compiler.internal.scopes.EmptyDefinitionStore

All Implemented Interfaces:

IDefinitionStore

public final class EmptyDefinitionStore
extends Object
implements IDefinitionStore

An implementation of IDefinitionStore that stores no definitions. Many scopes do not need to store any definitions. (For example, consider a typical getter.)

If scopes always have a non-null store, it makes the code simpler. However, every empty store behaves the same and therefore scopes with empty stores all share the singleton instance provided by EmptyDefinitionStore.SINGLETON.

Field Summary

Fields

Modifier and Type	Field and Description
static IDefinitionStore	SINGLETON The singleton instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(IDefinition definition) Adds a definition to this store.
IDefinitionStore	createLargerStore() Creates another definition store with a greater capacity.
Collection<IDefinition>	getAllDefinitions() Gets all the definitions in this store.
Collection<IDefinitionSet>	getAllDefinitionSets() Gets all the definitions sets in this store.
Collection<String>	getAllNames() Gets the base names of all the definition sets in this store.
int	getCapacity() Gets the maximum number of definition sets that this definition store can hold.
IDefinitionSet	getDefinitionSetByName(String baseName) Gets the set of definitions in this store that have a specified base name.
void	putDefinitionSetByName(String baseName, IDefinitionSet set) Puts a specified set of definitions with a specified base name into this store.
boolean	remove(IDefinition definition) Removes a definition from this store.

Methods inherited from class java.lang.Object

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

Field Detail

SINGLETON

public static final IDefinitionStore SINGLETON

The singleton instance of this class.

Method Detail

getCapacity

public int getCapacity()

Description copied from interface: IDefinitionStore

Gets the maximum number of definition sets that this definition store can hold.

Specified by:

getCapacity in interface IDefinitionStore

Returns:

The maximum number of definition sets.

createLargerStore

public IDefinitionStore createLargerStore()

Description copied from interface: IDefinitionStore

Creates another definition store with a greater capacity.

When a call to IDefinitionStore.add(org.apache.flex.compiler.definitions.IDefinition)() on this store returns false (because the store has reached its capacity), call this method to create a larger store and then call add()) on it. The second add() is guaranteed to succeed.

Specified by:

createLargerStore in interface IDefinitionStore

Returns:

An IDefinitionStore with a greater capacity.

add

public boolean add(IDefinition definition)

Description copied from interface: IDefinitionStore

Adds a definition to this store.

Specified by:

add in interface IDefinitionStore

Parameters:

definition - The IDefinition to add.

Returns:

A flag indicating whether the definition was added. It may not be possible to add the definition because some implementations of IDefinitionStore have limited storage capacity, as a memory optimization.

remove

public boolean remove(IDefinition definition)

Description copied from interface: IDefinitionStore

Removes a definition from this store.

Specified by:

remove in interface IDefinitionStore

Parameters:

definition - The IDefinition to remove.

Returns:

A flag indicating whether the definition was found.

getDefinitionSetByName

public IDefinitionSet getDefinitionSetByName(String baseName)

Description copied from interface: IDefinitionStore

Gets the set of definitions in this store that have a specified base name.

This method is called very frequently as part of name resolution. All implementations should be fast and avoid creating temporary objects.

Specified by:

getDefinitionSetByName in interface IDefinitionStore

Parameters:

baseName - The base name of the definitions you want to retrieve from the store.

Returns:

An IDefinitionSet containing the definition with that base name, or null if there are none.

putDefinitionSetByName

public void putDefinitionSetByName(String baseName,
                          IDefinitionSet set)

Description copied from interface: IDefinitionStore

Puts a specified set of definitions with a specified base name into this store.

This is only used when a project scope has to replace a definition set in its store because it has converted definition promises in the set to actual definitions.

Specified by:

putDefinitionSetByName in interface IDefinitionStore

Parameters:

baseName - The base name of the definitions in the set.

set - The IDefinitionSet of definitions to put into the store.

getAllNames

public Collection<String> getAllNames()

Description copied from interface: IDefinitionStore

Gets the base names of all the definition sets in this store.

Specified by:

getAllNames in interface IDefinitionStore

Returns:

An unordered collection of Strings for the base names.

getAllDefinitionSets

public Collection<IDefinitionSet> getAllDefinitionSets()

Description copied from interface: IDefinitionStore

Gets all the definitions sets in this store.

Specified by:

getAllDefinitionSets in interface IDefinitionStore

Returns:

An unordered collection of IDefinitionSet objects.

getAllDefinitions

public Collection<IDefinition> getAllDefinitions()

Description copied from interface: IDefinitionStore

Gets all the definitions in this store.

Specified by:

getAllDefinitions in interface IDefinitionStore

Returns:

An ordered collection of IDefinition objects.