com.atlassian.fisheye.ui.filedecoration

Interface GutterRenderer

public interface GutterRenderer

A Plugin point for gutter-decorating the display of revisions or diffs between revisions.

To register a gutter renderer, you need to add something like this to your atlassian-plugins.xml:

     <gutter-renderer key="my-gutter" class="com.company.MyGutter"/>
 

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<DiffLineDecorator>	getAnnotationDecorators(DiffType diffType, java.lang.String repository, java.lang.String fromPath, java.lang.String fromRev, java.lang.String toPath, java.lang.String toRev) Called to provide decorators for a given FishEye revision.
java.util.List<LineDecorator>	getAnnotationDecorators(java.lang.String repository, java.lang.String path, java.lang.String rev) Called to provide decorators for a given FishEye revision.

Method Detail

getAnnotationDecorators

java.util.List<LineDecorator> getAnnotationDecorators(java.lang.String repository,
                                                    java.lang.String path,
                                                    java.lang.String rev)

Called to provide decorators for a given FishEye revision. The decorators will be placed in the gutter during revision rendering (in the order they are returned).

Parameters:

repository - the FishEye repository name

path - path of the file

rev - revision of the file

Returns:

the decorators. Do not return null (if you do not want to decorate, just return an empty list)

getAnnotationDecorators

java.util.List<DiffLineDecorator> getAnnotationDecorators(DiffType diffType,
                                                        java.lang.String repository,
                                                        java.lang.String fromPath,
                                                        java.lang.String fromRev,
                                                        java.lang.String toPath,
                                                        java.lang.String toRev)

Called to provide decorators for a given FishEye revision. The decorators will be placed in the gutter during revision rendering (in the order they are returned).

Parameters:

repository - the FishEye repository name

diffType - the type of diff

fromPath - path of the file

fromRev - revision of the old revision

toRev - revision of the new revision

Returns:

the decorators. Do not return null (if you do not want to decorate, just return an empty list)