org.netbeans.api.java.source
Class ModificationResult

java.lang.Object
  org.netbeans.api.java.source.ModificationResult

public final class ModificationResult
extends Object

Class that collects changes built during a modification task run.

Nested Class Summary

static class

ModificationResult.Difference

Method Summary

void	commit() Once all of the changes have been collected, this method can be used to commit the changes to the source files
List<? extends ModificationResult.Difference>	getDifferences(FileObject fo)
Set<? extends FileObject>	getModifiedFileObjects()
Set<File>	getNewFiles()
String	getResultingSource(FileObject fileObject) Returned string represents preview of resulting source.
int[]	getSpan(Object tag) Provides span of tree tagged with tag

Methods inherited from class java.lang.Object

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

Method Detail

getModifiedFileObjects

public Set<? extends FileObject> getModifiedFileObjects()

getDifferences

public List<? extends ModificationResult.Difference> getDifferences(FileObject fo)

getNewFiles

public Set<File> getNewFiles()

commit

public void commit()
            throws IOException

Once all of the changes have been collected, this method can be used to commit the changes to the source files

Throws:

IOException

getResultingSource

public String getResultingSource(FileObject fileObject)
                          throws IOException

Returned string represents preview of resulting source. No difference really is applied. Respects isExcluded() flag of difference.

Parameters:

there - can be more resulting source, user has to specify which wants to preview.

Returns:

if changes are applied source looks like return string

Throws:

IOException

getSpan

public int[] getSpan(Object tag)

Provides span of tree tagged with tag

Parameters:

tag -

Returns:

borders in target document

Since:

0.37