net.sf.statcvs.weblinks.bugs

Class BugTracker

Known Direct Subclasses:
Bugzilla, Mantis

public abstract class BugTracker
extends Object

A BugTracker generates links to numbered bugs. We use this to turn bug references in commit log messages (e.g. "Bug #123") into clickable links.
Version:
$Id: BugTracker.java,v 1.8 2008/04/02 11:22:16 benoitx Exp $
Author:
Richard Cyganiak (richard@cyganiak.de)

Field Summary

static BugTracker
NO_BUG_TRACKER
A null object that can be used in place of a real bug tracker.
protected static Pattern
bugRegex

Constructor Summary

BugTracker(String baseURL)
Creates a new BugTracker instance.

Method Summary

String
baseURL()
Returns the bug tracker's base URL.
abstract String
bugURL(String bugNumber)
Returns the URL of the bug tracker page about a certain bug.
abstract String
getName()
Returns the name of the bug tracker
String
toHTMLWithLinks(String plainTextInput)
Filters a String, e.g.

Field Details

NO_BUG_TRACKER

public static final BugTracker NO_BUG_TRACKER
A null object that can be used in place of a real bug tracker.

bugRegex

protected static final Pattern bugRegex

Constructor Details

BugTracker

public BugTracker(String baseURL)
Creates a new BugTracker instance.
Parameters:
baseURL - The bug tracker's base URL; a slash is appended if it doesn't end in a slash

Method Details

baseURL

public String baseURL()
Returns the bug tracker's base URL.
Returns:
The bug tracker's base URL

bugURL

public abstract String bugURL(String bugNumber)
Returns the URL of the bug tracker page about a certain bug.
Parameters:
bugNumber - The bug number; one or more digits.
Returns:
The URL of the bug page

getName

public abstract String getName()
Returns the name of the bug tracker
Returns:
the name of the bug tracker

toHTMLWithLinks

public String toHTMLWithLinks(String plainTextInput)
Filters a String, e.g. a commit message, replacing bug references with links to the tracker.
Parameters:
plainTextInput - String to examine for bug references
Returns:
A copy of input, with bug references replaced with HTML links