| com.atlassian.bitbucket.content.ContentService |
Retrieves the diff, the content or the the blame information of a file.
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
This method is deprecated.
in 4.6 to note that the return type will change to
Page<Blame> in 5.0.
| |||||||||||
Performs a directory listing for the specified objectId+path from the specified repository, streaming the results
to the provided
callback. | |||||||||||
Streams the raw content of the file into an OutputStream obtained from the given TypeAwareOutputSupplier.
| |||||||||||
This method is deprecated.
in 4.6 to note that the return type will change to Page<Blame> in 5.0.
Returns Blame for the lines included by the provided PageRequest for the specified objectId+path
in the specified repository.
The objectId provided here can be several things:
This method has been deprecated because it doesn't return a normal Page response. That makes it
impossible to efficiently determine whether there is another page of blame after the requested page; the
only way to know is to request the next page and check the result.
| repository | the repository to use |
|---|---|
| objectId | an identifier (name or hash) for the branch, tag or commit at which blame should be retrieved |
| path | the path for which blame should be retrieved |
| pageRequest | defines the set of lines within the file for which blame should be generated |
Blame objects, ordered by the line at which they start in the filePerforms a directory listing for the specified objectId+path from the specified repository, streaming the results
to the provided callback.
The objectId provided here can be several things:
The listing is provided to the caller via a callback mechanism - the supplied ContentTreeCallback
parameter. This method promises to call onStart(ContentTreeContext) on the supplied instance
once followed by zero or more onTreeNode(ContentTreeNode)
for each path in the directory and finally followed by a onEnd(ContentTreeSummary).
When recursive is false, file sizes will be populated and subdirectories
below the specified path will be returned. For recursive listings, subdirectories and file sizes are
omitted to improve performance.
| repository | the repository to use |
|---|---|
| objectId | an identifier (name or hash) for the branch, tag or commit at which blame should be retrieved |
| path | the path for which blame should be retrieved |
| recursive | whether the directory listing should be recursive |
| callback | the callback instance to call as the page starts, the children nodes are encountered and as the page ends |
| pageRequest | defines the range of children in the listing the caller is interested in |
| repository | the repository |
|---|---|
| objectId | the identifier for a point in the repository. Can be a commit ID, a branch or a tag |
| path | the path to the file |
| pageRequest | the page request for the start and limit of the page |
| withBlame | true to include blame information for content; otherwise, false to omit it |
| fileContentCallback | the callback for receiving lines and page information |
| ServiceException | if the stream file operation fails |
|---|
Streams the raw content of the file into an OutputStream obtained from the given TypeAwareOutputSupplier. The implementation might try to detect the mime-type of the file, and pass that information to the TypeAwareOutputSupplier. Note: this method is not paged.
| repository | the repository to use |
|---|---|
| objectId | the identifier for a point in the repository. Can be a commit ID, branch or tag |
| path | the path to the file |
| supplier | an object that can return an OutputStream given a mime-type |
| ServiceException | if the stream operation fails. |
|---|