com.atlassian.bitbucket.content

Class AbstractFileContentCallback

java.lang.Object

com.atlassian.bitbucket.content.AbstractFileContentCallback

All Implemented Interfaces:

FileContentCallback

public class AbstractFileContentCallback
extends Object
implements FileContentCallback

Constructor Summary

Constructors

Constructor and Description
AbstractFileContentCallback()

Method Summary

Modifier and Type	Method and Description
void	offerBlame(Page<Blame> blames) If annotations were requested and at least one line was streamed, this method will be called before FileContentCallback.onEnd(FileSummary) to provide blame for the streamed lines.
void	onBinary() Called once if the file is binary.
void	onEnd(FileSummary summary) Called after the final line, and blame if requested, has been streamed.
boolean	onLine(int lineNumber, String line, boolean truncated) Ignores the provided line details and returns true, which will continue streaming.
void	onStart(FileContext context) Called before the first FileContentCallback.onLine(int, String, boolean).

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFileContentCallback

public AbstractFileContentCallback()

Method Detail

offerBlame

public void offerBlame(@Nonnull
                       Page<Blame> blames)
                throws IOException

Description copied from interface: FileContentCallback

If annotations were requested and at least one line was streamed, this method will be called before FileContentCallback.onEnd(FileSummary) to provide blame for the streamed lines.

Specified by:

offerBlame in interface FileContentCallback

Parameters:

blames - blame for the streamed lines

Throws:

IOException - may be thrown by implementations which perform I/O.

onBinary

public void onBinary()
              throws IOException

Description copied from interface: FileContentCallback

Called once if the file is binary. None of the other methods will be called.

Specified by:

onBinary in interface FileContentCallback

Throws:

IOException - if the callback fails

onEnd

public void onEnd(@Nonnull
                  FileSummary summary)
           throws IOException

Description copied from interface: FileContentCallback

Called after the final line, and blame if requested, has been streamed.

Note: If there were no lines, this method may be called immediately after FileContentCallback.onStart(FileContext) without any calls to FileContentCallback.onLine(int, String, boolean).

Specified by:

onEnd in interface FileContentCallback

Parameters:

summary - summarizes the file request and the streamed lines

Throws:

IOException - may be thrown by implementations which perform I/O.

onLine

public boolean onLine(int lineNumber,
                      String line,
                      boolean truncated)
               throws IOException

Ignores the provided line details and returns true, which will continue streaming.

Specified by:

onLine in interface FileContentCallback

Parameters:

lineNumber - the line number of the line in the file

line - a truncated line of code. The line character limit can be set at a system level via a system property

truncated - where the received line was truncated

Returns:

true

Throws:

IOException - may be thrown by derived classes

onStart

public void onStart(@Nonnull
                    FileContext context)
             throws IOException

Description copied from interface: FileContentCallback

Called before the first FileContentCallback.onLine(int, String, boolean).

Specified by:

onStart in interface FileContentCallback

Parameters:

context - provides details about the file request for which lines are being streamed

Throws:

IOException - may be thrown by implementations which perform I/O.