org.apache.flex.compiler.internal.scopes

Class SmallDefinitionStoreBase

java.lang.Object

org.apache.flex.compiler.internal.scopes.SmallDefinitionStoreBase

All Implemented Interfaces:

IDefinitionStore

Direct Known Subclasses:

SmallDefinitionStore1, SmallDefinitionStore2, SmallDefinitionStore4, SmallDefinitionStore8

public abstract class SmallDefinitionStoreBase
extends Object
implements IDefinitionStore

An abstract base class for implementations of IDefinitionStore that use a small number of fields, rather than a map, to store definition sets.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String[]	EMPTY_STRING_ARRAY

Constructor Summary

Constructors

Constructor and Description
SmallDefinitionStoreBase() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(IDefinition definition) Adds a definition to this store.
protected static void	addBaseNameToList(List<String> list, IDefinitionSet definitionSet) If the specified definition set is non-null and contains definitions, add the base name of those definitions to the specified list.
protected static void	addDefinitionSetToList(List<IDefinitionSet> list, IDefinitionSet definitionSet) If the specified definition set is non-null, add it to the specified list.
protected static void	addDefinitionsToList(List<IDefinition> list, IDefinitionSet definitionSet) If the specified definition set is non-null and contains definitions, add those definitions to the specified list.
static IDefinitionSet	addDefinitionToSet(IDefinitionSet oldDefinitionSet, IDefinition definition) Adds a new definition to a definition set, possibly creating a new definition set in the process (if the old definition set was null or couldn't hold the new definition).
protected abstract int	findAvailableIndex() Returns the index of the first null field where a new definition set can be stored.
protected abstract int	findIndexForBaseName(String baseName) Returns the index of the field storing a definition set with the specified base name, or -1 if there is no such field.
protected static String	getBaseName(IDefinitionSet definitionSet) Gets the base name of the definitions stored in the specified definition set.
abstract int	getCapacity() Gets the number of fields for storing definition sets.
protected abstract IDefinitionSet	getDefinitionSet(int i) Gets the definition set stored in the specified field.
abstract IDefinitionSet	getDefinitionSetByName(String baseName) Gets the set of definitions in this store that have a specified base name.
boolean	remove(IDefinition definition) Removes a definition from this store.
static boolean	removeDefinitionFromSet(IDefinitionSet definitionSet, IDefinition definition) Removes a definition from a definition set.
protected abstract void	setDefinitionSet(int i, IDefinitionSet definitionSet) Sets the specified definition set into the specified field.
String	toString() For debugging only.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flex.compiler.internal.scopes.IDefinitionStore

createLargerStore, getAllDefinitions, getAllDefinitionSets, getAllNames, putDefinitionSetByName

Field Detail

EMPTY_STRING_ARRAY

protected static final String[] EMPTY_STRING_ARRAY

Constructor Detail

SmallDefinitionStoreBase

public SmallDefinitionStoreBase()

Constructor.

Method Detail

getBaseName

protected static String getBaseName(IDefinitionSet definitionSet)

Gets the base name of the definitions stored in the specified definition set.

Parameters:

definitionSet - An IDefinitionSet or null.

Returns:

The base name, or null if the definition set was null or empty.

addDefinitionToSet

public static IDefinitionSet addDefinitionToSet(IDefinitionSet oldDefinitionSet,
                                IDefinition definition)

Adds a new definition to a definition set, possibly creating a new definition set in the process (if the old definition set was null or couldn't hold the new definition).

This method handles the fact that we use different optimized implementations of IDefinitionSet for different set sizes.

Parameters:

oldDefinitionSet - An IDefinitionSet containing definitions. This may be null if we are adding the first definition with a particular base name.

definition - The IDefinition to add to the set.

Returns:

Either the definition set that was passed in or a new definition set. In either case, the definition has been added.

removeDefinitionFromSet

public static boolean removeDefinitionFromSet(IDefinitionSet definitionSet,
                              IDefinition definition)

Removes a definition from a definition set.

This method handles the fact that we use different optimized implementations of IDefinitionSet for different set sizes.

Parameters:

definitionSet - An IDefinitionSet containing definitions.

definition - The IDefinition to be removed.

Returns:

true if the definition set is now empty and must be removed from the store.

addBaseNameToList

protected static void addBaseNameToList(List<String> list,
                     IDefinitionSet definitionSet)

If the specified definition set is non-null and contains definitions, add the base name of those definitions to the specified list.

This is a helper function used by subclasses to implement IDefinitionStore.getAllNames()(). Subclasses call this method for each field that can store a definition set.

Parameters:

list - A list of base names being built up.

definitionSet - An IDefinitionSet, which may be null or empty.

addDefinitionSetToList

protected static void addDefinitionSetToList(List<IDefinitionSet> list,
                          IDefinitionSet definitionSet)

If the specified definition set is non-null, add it to the specified list.

This is a helper function used by subclasses to implement IDefinitionStore.getAllDefinitionSets()(). Subclasses call this method for each field that can store a definition set. The field may be null or may contain an empty definition set.

Parameters:

list - A list of definition sets being built up.

definitionSet - An IDefinitionSet, which may be null or empty.

addDefinitionsToList

protected static void addDefinitionsToList(List<IDefinition> list,
                        IDefinitionSet definitionSet)

If the specified definition set is non-null and contains definitions, add those definitions to the specified list.

This is a helper function used by subclasses to implement IDefinitionStore.getAllDefinitions()(). Subclasses call this method for each field that can store a definition set.

Parameters:

list - A list of definitions being built up.

definitionSet - An IDefinitionSet, which may be null or empty.

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 abstract 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.

getCapacity

public abstract int getCapacity()

Gets the number of fields for storing definition sets.

Specified by:

getCapacity in interface IDefinitionStore

Returns:

The number of fields.

getDefinitionSet

protected abstract IDefinitionSet getDefinitionSet(int i)

Gets the definition set stored in the specified field.

Parameters:

i - The index of the field.

Returns:

The IDefinitionSet store there.

setDefinitionSet

protected abstract void setDefinitionSet(int i,
                    IDefinitionSet definitionSet)

Sets the specified definition set into the specified field.

Parameters:

i - The index of the field.

definitionSet - The IDefinitionSet to store there.

findIndexForBaseName

protected abstract int findIndexForBaseName(String baseName)

Returns the index of the field storing a definition set with the specified base name, or -1 if there is no such field.

Parameters:

baseName - The base name to look for.

Returns:

The index of the field whose definition set has this base name.

findAvailableIndex

protected abstract int findAvailableIndex()

Returns the index of the first null field where a new definition set can be stored.

Returns:

The index of a null field, or - is there is no such field.

toString

public String toString()

For debugging only.

Overrides:

toString in class Object