org.netbeans.api.java.source

Class ModificationResult.Difference

java.lang.Object

org.netbeans.api.java.source.ModificationResult.Difference

Enclosing class:

ModificationResult

public static class ModificationResult.Difference
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModificationResult.Difference.Kind

Method Summary

Modifier and Type	Method and Description
void	exclude(boolean b)
String	getDescription()
Position	getEndPosition()
ModificationResult.Difference.Kind	getKind()
String	getNewText()
String	getOldText()
Position	getStartPosition()
boolean	isCommitToGuards() Gets flag if it is possible to write to guarded sections.
boolean	isExcluded()
Document	openDocument() Opens a Document where the Difference is to be applied.
void	setCommitToGuards(boolean b) Sets flag if it is possible to write to guarded sections.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getKind

@NonNull
public ModificationResult.Difference.Kind getKind()

getStartPosition

@NonNull
public Position getStartPosition()

getEndPosition

@NonNull
public Position getEndPosition()

getOldText

@NonNull
public String getOldText()

getNewText

@NonNull
public String getNewText()

isExcluded

public boolean isExcluded()

exclude

public void exclude(boolean b)

isCommitToGuards

public boolean isCommitToGuards()

Gets flag if it is possible to write to guarded sections.

Returns:

true in case the difference may be written even into guarded sections.

Since:

0.33

See Also:

ModificationResult.Difference.setCommitToGuards(boolean)

setCommitToGuards

public void setCommitToGuards(boolean b)

Sets flag if it is possible to write to guarded sections.

Parameters:

b - flag if it is possible to write to guarded sections

Since:

0.33

toString

public String toString()

Overrides:

toString in class Object

getDescription

public String getDescription()

openDocument

@CheckForNull
public Document openDocument()
                                    throws IOException

Opens a Document where the Difference is to be applied. Throws IOException, if the document open fails. If the document is already opened, returns the opened instance. If the difference is CREATE and the document does not exist yet, the method may return null

Returns:

Document to apply the Difference.

Throws:

IOException - when document open fails

Since:

java.source.base 1.1