org.apache.flex.compiler.internal.scopes

Interface IDefinitionStore

All Known Implementing Classes:

EmptyDefinitionStore, LargeDefinitionStore, SmallDefinitionStore1, SmallDefinitionStore2, SmallDefinitionStore4, SmallDefinitionStore8, SmallDefinitionStoreBase

public interface IDefinitionStore

An IDefinitionStore is used by a scope to store a collection of definitions, organized into sets of definition sthat have the same base name.

The IDefinitionStore is completely private to the scope and is not exposed by any scope APIs.

Since many scopes contain only a few definitions, there are multiple implementations of this interface, optimized for storing 0, 1, 2, 4, 8, and an unlimited number of definitions.

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.

Method Detail

getCapacity

int getCapacity()

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

Returns:

The maximum number of definition sets.

createLargerStore

IDefinitionStore createLargerStore()

Creates another definition store with a greater capacity.

When a call to 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.

Returns:

An IDefinitionStore with a greater capacity.

add

boolean add(IDefinition definition)

Adds a definition to this store.

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

boolean remove(IDefinition definition)

Removes a definition from this store.

Parameters:

definition - The IDefinition to remove.

Returns:

A flag indicating whether the definition was found.

getDefinitionSetByName

IDefinitionSet getDefinitionSetByName(String baseName)

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.

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

void putDefinitionSetByName(String baseName,
                          IDefinitionSet set)

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.

Parameters:

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

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

getAllNames

Collection<String> getAllNames()

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

Returns:

An unordered collection of Strings for the base names.

getAllDefinitionSets

Collection<IDefinitionSet> getAllDefinitionSets()

Gets all the definitions sets in this store.

Returns:

An unordered collection of IDefinitionSet objects.

getAllDefinitions

Collection<IDefinition> getAllDefinitions()

Gets all the definitions in this store.

Returns:

An ordered collection of IDefinition objects.