org.netbeans.spi.java.hints

Class JavaFix.TransformationContext

java.lang.Object

org.netbeans.spi.java.hints.JavaFix.TransformationContext

Enclosing class:

JavaFix

public static final class JavaFix.TransformationContext
extends Object

A context that contains a reference to a WorkingCopy through which modifications of Java source code can be made.

Method Summary

Modifier and Type	Method and Description
TreePath	getPath() Returns the TreePath that was passed to a JavaFix constructor.
InputStream	getResourceContent(FileObject file) Allows access to non-Java resources.
OutputStream	getResourceOutput(FileObject file) Record a changed version of a file.
WorkingCopy	getWorkingCopy() A WorkingCopy over which the transformation should operate.

Methods inherited from class java.lang.Object

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

Method Detail

getPath

@NonNull
public TreePath getPath()

Returns the TreePath that was passed to a JavaFix constructor.

Returns:

the TreePath that was passed to a JavaFix constructor.

getWorkingCopy

@NonNull
public WorkingCopy getWorkingCopy()

A WorkingCopy over which the transformation should operate.

Returns:

WorkingCopy over which the transformation should operate.

getResourceContent

@NonNull
public InputStream getResourceContent(@NonNull
                                               FileObject file)
                                        throws IOException,
                                               IllegalArgumentException

Allows access to non-Java resources. The content of this InputStream will include all changes done through JavaFix.TransformationContext.getResourceOutput(org.openide.filesystems.FileObject) before calling this method.

Parameters:

file - whose content should be returned

Returns:

the file's content

Throws:

IOException - if something goes wrong while opening the file

IllegalArgumentException - if file parameter is null, or if it represents a Java file

getResourceOutput

@NonNull
public OutputStream getResourceOutput(@NonNull
                                               FileObject file)
                                        throws IOException

Record a changed version of a file. The changes will be applied altogether with changes to the Java file. In Inspect&Transform, changes done through this method will be part of the preview.

Parameters:

file - whose content should be changed

Returns:

an OutputStream into which the new content of the file should be written

Throws:

IOException - if something goes wrong while opening the file

IllegalArgumentException - if file parameter is null, or if it represents a Java file