org.jenkinsci.plugins.imagegallery.comparative

Class ComparativeArchivedImagesGallery

java.lang.Object

org.jenkinsci.plugins.imagegallery.ImageGallery

org.jenkinsci.plugins.imagegallery.AbstractArchivedImagesGallery

org.jenkinsci.plugins.imagegallery.comparative.ComparativeArchivedImagesGallery

All Implemented Interfaces:

Describable<ImageGallery>, Serializable, Comparable<ImageGallery>

Direct Known Subclasses:

InFolderComparativeArchivedImagesGallery, MultipleFolderComparativeArchivedImagesGallery

public abstract class ComparativeArchivedImagesGallery
extends AbstractArchivedImagesGallery

Base image gallery to compare images in different way.

Since:

1.0

Author:

Richard Lavoie

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ComparativeArchivedImagesGallery.ComparativeDescriptorImpl

Constructor Summary

Constructors

Constructor and Description
ComparativeArchivedImagesGallery(String title, String baseRootFolder, String imageWidthText, String imageInnerWidthText, boolean markBuildAsUnstableIfNoArchivesFound) Constructor called from jelly.

Method Summary

Modifier and Type	Method and Description
String	getBaseRootFolder()
String	getImageInnerWidthText()
protected List<String>	getRelativeFrom(FilePath file, FilePath parent) Retrieve an array with the directories required to go from parent to file.
String	getTitle()

Methods inherited from class org.jenkinsci.plugins.imagegallery.AbstractArchivedImagesGallery

isMarkBuildAsUnstableIfNoArchivesFound

Methods inherited from class org.jenkinsci.plugins.imagegallery.ImageGallery

all, allExcept, compareTo, createImageGallery, getDescriptor, getImageWidthText, getProjectActions

Methods inherited from class java.lang.Object

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

Constructor Detail

ComparativeArchivedImagesGallery

public ComparativeArchivedImagesGallery(String title,
                                        String baseRootFolder,
                                        String imageWidthText,
                                        String imageInnerWidthText,
                                        boolean markBuildAsUnstableIfNoArchivesFound)

Constructor called from jelly.

Parameters:

title - gallery title

baseRootFolder - base root folder

imageWidthText - width

imageInnerWidthText - inner width

markBuildAsUnstableIfNoArchivesFound - flag to fail build if nothing found

Method Detail

getTitle

public String getTitle()

Overrides:

getTitle in class ImageGallery

Returns:

the title

getBaseRootFolder

public String getBaseRootFolder()

Returns:

the baseRootFolder

getImageInnerWidthText

public String getImageInnerWidthText()

Returns:

the imageInnerWidthText

getRelativeFrom

protected List<String> getRelativeFrom(FilePath file,
                                       FilePath parent)

Retrieve an array with the directories required to go from parent to file. Like in a network where you can trace for hops.

For example, from /home/silb/archives to /home/silb/archives/images/1.png, the method will return an array with images and 1.png.

Parameters:

file - target file

parent - parent file

Returns:

an array with directories to go from parent to file.