oracle.jdeveloper.audit.java
Class JavaTransformAdapter

java.lang.Object
  oracle.jdeveloper.audit.transform.TransformAdapter
      oracle.jdeveloper.audit.java.JavaTransformAdapter

public class JavaTransformAdapter
extends TransformAdapter

An adapter between the Audit framework and transforms which use the JDeveloper Java model (oracle.javatools.parser.java.v2.model).

Nested Class Summary

Nested classes/interfaces inherited from class oracle.jdeveloper.audit.transform.TransformAdapter

TransformAdapter.ConstructRegion, TransformAdapter.LocationRegion, TransformAdapter.Region

Constructor Summary

JavaTransformAdapter()

Method Summary

void	beginTransform(TransformContext context) Begins a transform of this type.
void	beginTransform(TransformContext context, TransformSequenceContext sequenceContext) The default implementation simply calls beginTransform with the current transform context.
void	beginTransformSequence(TransformSequenceContext sequenceContext) Begins a transform sequence.
void	cancelTransform(TransformContext context) Cancels a transform of this type.
void	cancelTransformSequence(TransformSequenceContext sequenceContext) Cancels a transform sequence of this type.
TransformContext	createContext(Transform transform, Violation violation, Location location) Creates a context for a transform over a violation.
void	endTransform(TransformContext context) Ends a transform of this type.
void	endTransformSequence(TransformSequenceContext sequenceContext) Ends a transform sequence.
java.lang.Class	getContextClass() Gets the class of the context created by TransformAdapter.createContext(oracle.jdeveloper.audit.transform.Transform, oracle.jdeveloper.audit.service.Violation, oracle.jdeveloper.audit.model.Location).

Methods inherited from class oracle.jdeveloper.audit.transform.TransformAdapter

addHighlight, addRemovedHighlight, getDeferredCommands, getHighlightRegions, getSelection, invokeLater, setPredecessorApplyData, setSelection, setSelection

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaTransformAdapter

public JavaTransformAdapter()

Method Detail

getContextClass

public java.lang.Class getContextClass()

Description copied from class: TransformAdapter

Gets the class of the context created by TransformAdapter.createContext(oracle.jdeveloper.audit.transform.Transform, oracle.jdeveloper.audit.service.Violation, oracle.jdeveloper.audit.model.Location).

Specified by:

getContextClass in class TransformAdapter

createContext

public TransformContext createContext(Transform transform,
                                      Violation violation,
                                      Location location)

Description copied from class: TransformAdapter

Creates a context for a transform over a violation.

Specified by:

createContext in class TransformAdapter

beginTransformSequence

public void beginTransformSequence(TransformSequenceContext sequenceContext)

Begins a transform sequence. A transform sequence is a sequence of transforms which use the same TransformAdapter subclass and are applied in sequence to a single model. The sequence context is used to remember information about the state of the document, such as which imports were unused to begin with and which ones should be retained, in the case of Java files. The framework ensures the following before invoking this method:

• CommandProcessor.beginTrans(java.lang.String) has been invoked to start a command processor batch operation;
• the calling thread holds a read lock on the model containing the first transform's violation location;

  The JavaTransformAdapter implementation of this method compiles the SourceFile and checks for imports that are unused to begin with, adding them to a set and making that set an attribute of the sequence context.

  Overrides:

  beginTransformSequence in class TransformAdapter

  Parameters:

  sequenceContext -

beginTransform

public void beginTransform(TransformContext context)

Begins a transform of this type. The framework ensures the following before invoking this method:

• CommandProcessor.beginTrans(java.lang.String) has been invoked to start a command processor batch operation;
• the calling thread holds a read lock on the model containing the transform location;
• the transform class has an apply method that matches the construct at the violation location;
• if the transform class has an isApplicable method that matches the construct at the violation location, it has been invoked and has returned true;
• if the transform class has a query method that matches the construct at the violation location, it has been invoked and has returned non-null data.

  The JavaTransformAdapter implementation of this method acquires and write locks the text buffer of the node to be transformed and invokes beginTransaction on its root construct, the SourceFile. This method leaves the text buffer write locked.

  Specified by:

  beginTransform in class TransformAdapter

  Parameters:

  context -

beginTransform

public void beginTransform(TransformContext context,
                           TransformSequenceContext sequenceContext)

Description copied from class: TransformAdapter

The default implementation simply calls beginTransform with the current transform context. Subclasses that need support for transform sequences should therefore override this method.

Overrides:

beginTransform in class TransformAdapter

endTransform

public void endTransform(TransformContext context)
                  throws java.lang.Exception

Ends a transform of this type. The framework ensures the following before invoking this method:

• TransformAdapter.beginTransform(oracle.jdeveloper.audit.transform.TransformContext) has been invoked (its preconditions still hold);
• the apply method that matches this construct has been invoked and has returned normally.

  The JavaTransformAdapter implementation of this method invokes

  Specified by:

  endTransform in class TransformAdapter

  Parameters:

  context - A transform context created by this adapter.

  Throws:

  java.lang.Exception

cancelTransform

public void cancelTransform(TransformContext context)
                     throws java.lang.Exception

Cancels a transform of this type. The framework ensures the following before invoking this method:

• TransformAdapter.beginTransform(oracle.jdeveloper.audit.transform.TransformContext) has been invoked (its preconditions still hold);
• the apply method that matches this construct has been invoked;
• the apply method has thrown an exception or the apply method has completed normally and the TransformAdapter.endTransform(oracle.jdeveloper.audit.transform.TransformContext) method has thrown an exception.

  The JavaTransformAdapter implementation of this method invokes

  Specified by:

  cancelTransform in class TransformAdapter

  Parameters:

  context - A transform context created by this type.

  Throws:

  java.lang.Exception

endTransformSequence

public void endTransformSequence(TransformSequenceContext sequenceContext)
                          throws java.lang.Exception

Ends a transform sequence. Before invoking this method, the framework ensures that TransformAdapter.beginTransformSequence(oracle.jdeveloper.audit.transform.TransformSequenceContext) has been invoked and its preconditions still hold.

The JavaTransformAdapter implementation of this method acquires and write locks the text buffer of the node to be transformed and invokes beginTransaction on its root construct, the SourceFile. Then, it compiles the file and removes any unused imports that were neither unused to begin with nor explicitly retained along the way.

Overrides:

endTransformSequence in class TransformAdapter

Parameters:

sequenceContext - A transform sequence context created by this adapter.

Throws:

java.lang.Exception

cancelTransformSequence

public void cancelTransformSequence(TransformSequenceContext sequenceContext)
                             throws java.lang.Exception

Cancels a transform sequence of this type. The framework ensures the following before invoking this method:

• TransformAdapter.beginTransformSequence(oracle.jdeveloper.audit.transform.TransformSequenceContext) has been invoked (its preconditions still hold);
• the apply method that matches this construct has been invoked;
• the apply method has thrown an exception or the apply method has completed normally and the TransformAdapter.endTransformSequence(oracle.jdeveloper.audit.transform.TransformSequenceContext) method has thrown an exception.

  The JavaTransformAdapter implementation of this method is meant to perform any necessary cleanup of sequence events.

  Overrides:

  cancelTransformSequence in class TransformAdapter

  Parameters:

  sequenceContext - A transform sequence context created by this type.

  Throws:

  java.lang.Exception