com.goldencode.ast

Class InMemoryRegistryPlugin

java.lang.Object

com.goldencode.ast.BasePlugin

com.goldencode.ast.InMemoryRegistryPlugin

All Implemented Interfaces:

AstManagerPlugin

public class InMemoryRegistryPlugin
extends BasePlugin

Defines an in-memory

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.ast.BasePlugin

BasePlugin.Pair

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,Aast>	asts In-memory storage of ASTs, by their name.

Fields inherited from class com.goldencode.ast.BasePlugin

dirty, fids, fnames, HIGH_BITS, locklist, MAX_POSSIBLE, TREE_MASK

Constructor Summary

Constructors

Constructor and Description
InMemoryRegistryPlugin()

Method Summary

Modifier and Type	Method and Description
boolean	isExistingAst(java.lang.String name) Check if the AST specified by the given name exists already in the plugin's storage.
Aast	loadTree(java.lang.String name) Load a named AST from the in-memory storage, by returning a copy of the asts entry after using the specified name as the key.
boolean	removeTree(long id) Removes this tree from the in-memory storage.
void	save() A no-op for this in-memory storage.
void	saveTree(Aast ast, java.lang.String name, boolean terse) Save the given AST to in-memory storage under the given name.
private void	terseTree(Aast ast) Set the line and column information to 0 for the entire tree.
boolean	usesMemoryStorage() Does this plug-in use memory as its primary storage medium? This implementation overrides the superclass' implementation to return true.

Methods inherited from class com.goldencode.ast.BasePlugin

addTree, getFiles, getNextNodeId, getTreeId, getTreeId, getTreeName, isInvalid, lockTree, resetNextNodeId, setFlags, setNextNodeId, unlockTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.ast.AstManagerPlugin

dom2string

Field Detail

asts

private final java.util.Map<java.lang.String,Aast> asts

In-memory storage of ASTs, by their name.

Constructor Detail

InMemoryRegistryPlugin

public InMemoryRegistryPlugin()

Method Detail

usesMemoryStorage

public boolean usesMemoryStorage()

Does this plug-in use memory as its primary storage medium? This implementation overrides the superclass' implementation to return true.

Specified by:

usesMemoryStorage in interface AstManagerPlugin

Overrides:

usesMemoryStorage in class BasePlugin

Returns:

true.

loadTree

public Aast loadTree(java.lang.String name)
              throws AstException,
                     java.lang.IllegalArgumentException

Load a named AST from the in-memory storage, by returning a copy of the asts entry after using the specified name as the key.

Parameters:

name - The name of the tree. Often this is a file name.

Returns:

The loaded AST.

Throws:

AstException - On any error during the loading process.

java.lang.IllegalArgumentException - If the name is invalid or the specified resource doesn't exist.

saveTree

public void saveTree(Aast ast,
                     java.lang.String name,
                     boolean terse)
              throws AstException,
                     java.lang.IllegalArgumentException

Save the given AST to in-memory storage under the given name. This will save a copy of the specified AST in the asts map, usin the specified name as the key.

Parameters:

ast - The tree to save.

name - The name of the tree. Often this is a file name.

terse - Do not store line and column data when the node data is saved.

Throws:

AstException - On any error during the saving process.

java.lang.IllegalArgumentException - If the name is invalid or the specified resource cannot be used as a target to store the AST.

save

public void save()
          throws AstException

A no-op for this in-memory storage.

Throws:

AstException - On any failure.

removeTree

public boolean removeTree(long id)
                   throws AstException

Removes this tree from the in-memory storage.

Specified by:

removeTree in interface AstManagerPlugin

Overrides:

removeTree in class BasePlugin

Parameters:

id - The ID the tree to remove.

Returns:

true if the tree existed in the registry (and was removed), false if the tree didn't exist.

Throws:

AstException

See Also:

BasePlugin.removeTree(long)

isExistingAst

public boolean isExistingAst(java.lang.String name)

Check if the AST specified by the given name exists already in the plugin's storage.

Parameters:

name - The name (including path) of the AST file to be checked.

Returns:

true if the specified AST is in the plugin's storage.

terseTree

private void terseTree(Aast ast)

Set the line and column information to 0 for the entire tree.

Parameters:

ast - The AST which needs the column/line information to be removed.