|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IFilePatchResult
A file patch result provides the results of an attempt to apply an
IFilePatch2
to the contents of a file. *
IFilePatch2
IFilePatch2
.Method Summary | |
---|---|
String |
getCharset()
Returns the name of a charset encoding to be used when decoding the contents of this result into characters. |
InputStream |
getOriginalContents()
Return a stream the contains the original contents of the file before any portions of the patch have been applied. |
InputStream |
getPatchedContents()
Return a stream that contains the file with as much of the patch applied as possible. if hasMatches() returns false
then the patched contents will match the original contents. |
IHunk[] |
getRejects()
Return the portions of the patch (referred to a hunks) that could not be applied. |
boolean |
hasMatches()
Return whether the patch has portions that were successfully applied. |
boolean |
hasRejects()
Return whether the patch has portions that were not successfully applied. |
Method Detail |
---|
InputStream getOriginalContents()
getPatchedContents()
InputStream getPatchedContents()
hasMatches()
returns false
then the patched contents will match the original contents. Otherwise,
at least a portion of the patch could be successfully applied. if
hasRejects()
returns false
, then the entire patch was
applied. Otherwise, portions could not be applied. The portions that could
not be applied can be obtained by calling getRejects()
.
boolean hasMatches()
getPatchedContents()
boolean hasRejects()
getPatchedContents()
IHunk[] getRejects()
getPatchedContents()
String getCharset() throws CoreException
null
if a proper
encoding cannot be determined.
Note that this method does not check whether the result is a supported
charset name. Callers should be prepared to handle
UnsupportedEncodingException
where this charset is used.
null
CoreException
- if an error happens while determining
the charset. See any refinements for more information.
|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.