com.goldencode.p2j.convert

Class NameMappingWorker.Library

java.lang.Object

com.goldencode.p2j.convert.NameMappingWorker.Library

Enclosing class:

NameMappingWorker

public class NameMappingWorker.Library
extends java.lang.Object

Class whose instance is actually registered with the pattern engine's symbol resolver as the primary library of name mapping user functions.

Constructor Summary

Constructors

Constructor and Description
Library()

Method Summary

Modifier and Type	Method and Description
NameMappingWorker.MethodInfo	addMethod(NameMappingWorker.ProgramInfo parent, java.lang.String pname, java.lang.String jname) Add a new converted method entry, with the given legacy and converted name, to the given program.
java.util.Map<java.lang.String,java.lang.String>	addParameter(NameMappingWorker.MethodInfo parent) Add a new empty parameter to the given method (which can be an external program).
java.util.Map<java.lang.String,java.lang.String>	addParameter(NameMappingWorker.MethodInfo parent, java.lang.String pname, java.lang.String jname) Add a new parameter to the given method (which can be an external program).
boolean	classNameExists(java.lang.String pkg, java.lang.String name) Utility function which checks if a class name is registered in the given package location as a converted class.
NameMappingWorker.ProgramInfo	createProgramInfo(java.lang.String pname, java.lang.String jname) Create a new converted program entry, with the given legacy and converted name.
void	putAttribute(NameMappingWorker.MethodInfo info, java.lang.String name, java.lang.String value) Put an attribute with the given name and value for the specified method.
void	restoreMappings(java.lang.String filename) Given a filename with the XML structure with all the name mappings, load it in the NameMappingWorker.programs map.
void	storeMappings(XmlAst root) Given a root node, store all the mappings from the NameMappingWorker.programs map.

Methods inherited from class java.lang.Object

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

Constructor Detail

Library

public Library()

Method Detail

createProgramInfo

public NameMappingWorker.ProgramInfo createProgramInfo(java.lang.String pname,
                                                       java.lang.String jname)

Create a new converted program entry, with the given legacy and converted name.

Parameters:

pname - The legacy name.

jname - The converted name.

Returns:

A new NameMappingWorker.ProgramInfo instance.

putAttribute

public void putAttribute(NameMappingWorker.MethodInfo info,
                         java.lang.String name,
                         java.lang.String value)

Put an attribute with the given name and value for the specified method.

Parameters:

info - The method information object.

name - The attribute name.

value - The attribute value.

addMethod

public NameMappingWorker.MethodInfo addMethod(NameMappingWorker.ProgramInfo parent,
                                              java.lang.String pname,
                                              java.lang.String jname)

Add a new converted method entry, with the given legacy and converted name, to the given program.

Parameters:

parent - The method's external program owner.

pname - The legacy name.

jname - The converted name.

Returns:

A new NameMappingWorker.MethodInfo instance.

addParameter

public java.util.Map<java.lang.String,java.lang.String> addParameter(NameMappingWorker.MethodInfo parent,
                                                                     java.lang.String pname,
                                                                     java.lang.String jname)

Add a new parameter to the given method (which can be an external program).

Parameters:

parent - The parameter's method owner.

pname - The legacy name.

jname - The converted name.

Returns:

A map to hold the parameter's attributes.

addParameter

public java.util.Map<java.lang.String,java.lang.String> addParameter(NameMappingWorker.MethodInfo parent)

Add a new empty parameter to the given method (which can be an external program).

Parameters:

parent - The parameter's method owner.

Returns:

A map to hold the parameter's attributes.

storeMappings

public void storeMappings(XmlAst root)

Given a root node, store all the mappings from the NameMappingWorker.programs map.

Parameters:

root - The root element.

restoreMappings

public void restoreMappings(java.lang.String filename)
                     throws java.lang.Exception

Given a filename with the XML structure with all the name mappings, load it in the NameMappingWorker.programs map.

Parameters:

filename - The file from which to read the name mappings.

Throws:

java.lang.Exception

classNameExists

public boolean classNameExists(java.lang.String pkg,
                               java.lang.String name)

Utility function which checks if a class name is registered in the given package location as a converted class.

Parameters:

pkg - The package in which we want to check if there is any class by the given name.

name - The class name we want to check for existence.

Returns:

true if a class with that name exists in the given package or false otherwise.