com.atlassian.stash.repository.RefCallback2 |
Known Indirect Subclasses
|
Class Overview
RefCallback2
adds onStart(RefContext)
and onEnd(RefSummary)
methods.
onStart(RefContext)
will be called before the first ref
is streamed and
onEnd(RefSummary)
will be called after all refs have been streamed.
Note: This interface is
transitional and will be folded back into
RefCallback
in Stash 3.0.
Implementors are
strongly encouraged to extend from
AbstractRefCallback
. This interface
will
change over time, and any class implementing it directly will be broken by those changes. Extending the abstract
class will help minimize such breakages.
Summary
[Expand]
Inherited Methods |
From interface
com.atlassian.stash.repository.RefCallback
@Deprecated
void
|
onRef(Ref ref)
This method is deprecated.
in 2.10 for update in 3.0. This method will not be removed. However, its signature will be
changed to return boolean , to allow the callback to terminate streaming, and to add
throws IOException , consistent with methods on other callbacks.
|
|
Public Methods
public
void
onEnd
(RefSummary summary)
Called after the final ref
has been streamed.
Note: If there were no refs, this method may be called immediately after
onStart(RefContext)
without
any calls to
onRef(Ref)
.
Parameters
summary
| summarizes the request and the streamed refs |
Throws
IOException
| May be thrown by implementations which perform I/O.
|
public
void
onStart
(RefContext context)
Called before the first ref
is streamed.
Parameters
context
| provides details about the request for which refs are being streamed |
Throws
IOException
| May be thrown by implementations which perform I/O.
|