com.preemptive.dasho.mapfile

Interface MapFileHandler

All Known Implementing Classes:

MapFileWriter

public interface MapFileHandler

Handler interface used to deal with the sequence of information found in a map file. The handler to structure the production or consumption of information in a map file regardless of its source. The methods should be called in the following order:

• startFile() - exactly once
• startClass() - zero or more times
  • method() - zero or more times
  • field() - zero or more times
• endClass() - once for each startClass()
• endFile() - exactly once

Method Summary

Modifier and Type	Method and Description
void	endClass() Called to indicate that the current class has ended.
void	endFile() Called to indicate that the processing of the map file has ended.
void	field(java.lang.String originalName, java.lang.String originalSignature, java.lang.String newName) Called to indicate that a field is being processed.
void	method(java.lang.String originalName, java.lang.String originalSignature, java.lang.String newName) Called to indicate that a method is being processed.
void	startClass(java.lang.String originalName, java.lang.String newName) Called to indicate that a class is starting.
void	startFile() Called indicate that the processing of a map file has started.

Method Detail

startFile

void startFile()
        throws java.io.IOException

Called indicate that the processing of a map file has started.

Throws:

java.io.IOException - on various problems

See Also:

endFile()

endFile

void endFile()
      throws java.io.IOException

Called to indicate that the processing of the map file has ended.

Throws:

java.io.IOException - on various problems

See Also:

startFile()

startClass

void startClass(java.lang.String originalName,
                java.lang.String newName)
         throws java.io.IOException

Called to indicate that a class is starting. This can be called one or more times between calls to startFile() and endFile().

Parameters:

originalName - the original name of the class in class file format

newName - the new name of the class in class file format. May be null.

Throws:

java.io.IOException - on various problems

See Also:

endClass()

endClass

void endClass()
       throws java.io.IOException

Called to indicate that the current class has ended.

Throws:

java.io.IOException - on various problems

See Also:

startClass(String, String), endClass()

method

void method(java.lang.String originalName,
            java.lang.String originalSignature,
            java.lang.String newName)
     throws java.io.IOException

Called to indicate that a method is being processed. This can be called one or more times between calls to startClass() and endClass().

Parameters:

originalName - the original name of the method

originalSignature - the signature of the method in class file format

newName - the new name of the method. May be null.

Throws:

java.io.IOException - on various problems

See Also:

startClass(String, String), endClass()

field

void field(java.lang.String originalName,
           java.lang.String originalSignature,
           java.lang.String newName)
    throws java.io.IOException

Called to indicate that a field is being processed. This can be called one or more times between calls to startClass() and endClass().

Parameters:

originalName - the original name of the field.

originalSignature - the signature (type) of the field in class file format

newName - the new name for the field. May be null.

Throws:

java.io.IOException - on various problems

See Also:

startClass(String, String), endClass()