org.netbeans.modules.bugtracking.spi

Class BugtrackingSupport<R,Q,I>

java.lang.Object

org.netbeans.modules.bugtracking.spi.BugtrackingSupport<R,Q,I>

Type Parameters:

R - the implementation specific repository type

Q - the implementation specific query type

I - the implementation specific issue type

public final class BugtrackingSupport<R,Q,I>
extends Object

Collection of utility methods for bugtracking systems implementors.

Since:

1.85

Constructor Summary

Constructors

Constructor and Description
BugtrackingSupport(RepositoryProvider<R,Q,I> repositoryProvider, QueryProvider<Q,I> queryProvider, IssueProvider<I> issueProvider) Creates a new BugtrackingSupport preconfigured with mandatory provider implementations.

Method Summary

Modifier and Type	Method and Description
void	addToCategory(R r, I i) Opens a UI to select an Tasks Dashboard Category to add the given Issue into.
Repository	createRepository(R r, IssueStatusProvider<R,I> issueStatusProvider, IssueScheduleProvider<I> issueSchedulingProvider, IssuePriorityProvider<I> issuePriorityProvider, IssueFinder issueFinder) Factory method to create a Repository instance configured with optional providers.
void	editQuery(R r, Q q) Opens in the editor area a TopComponent with the given Queries UI in edit mode.
boolean	editRepository(R r, String errorMessage) Opens a UI to edit a repository.
Image[]	getPriorityIcons() Priority icons used by default in the Tasks Dashboard sorted from the highest priority.
void	openIssue(R r, I i) Opens in the editor area a TopComponent with the given Issues UI in edit mode.
void	setQueryAutoRefresh(R r, Q q, boolean autoRefresh) Determines default auto-refresh for a given query.

Methods inherited from class java.lang.Object

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

Constructor Detail

BugtrackingSupport

public BugtrackingSupport(RepositoryProvider<R,Q,I> repositoryProvider,
                          QueryProvider<Q,I> queryProvider,
                          IssueProvider<I> issueProvider)

Creates a new BugtrackingSupport preconfigured with mandatory provider implementations.

Parameters:

repositoryProvider - a RepositoryProvider to access the implementation specific repository.
Is mandatory and cannot be null.

queryProvider - a QueryProvider to access queries from the given repository.
Is mandatory and cannot be null.

issueProvider - an IssueProvider to access issues from the given repository.
Is mandatory and cannot be null.

Since:

1.85

Method Detail

createRepository

public Repository createRepository(R r,
                                   IssueStatusProvider<R,I> issueStatusProvider,
                                   IssueScheduleProvider<I> issueSchedulingProvider,
                                   IssuePriorityProvider<I> issuePriorityProvider,
                                   IssueFinder issueFinder)

Factory method to create a Repository instance configured with optional providers.

Parameters:

r - a implementation specific repository instance

issueStatusProvider - an IssueStatusProvider to provide status information of an implementation specific issue.
Might be null.

issueSchedulingProvider - an IssueScheduleProvider to provide scheduling information of an implementation specific issue.
Might be null.

issuePriorityProvider - an IssuePriorityProvider to provide priority information of an implementation specific issue.
Might be null.

issueFinder - an IssueFinder to find issue references in text..
Might be null.

Returns:

a Repository instance

Since:

1.85

editQuery

public void editQuery(R r,
                      Q q)

Opens in the editor area a TopComponent with the given Queries UI in edit mode.

Parameters:

r - a implementation specific Repository instance

q - a implementation specific Query instance

Since:

1.85

See Also:

QueryController

openIssue

public void openIssue(R r,
                      I i)

Opens in the editor area a TopComponent with the given Issues UI in edit mode.

Parameters:

r - a implementation specific Repository instance

i - a implementation specific Issue instance

Since:

1.85

addToCategory

public void addToCategory(R r,
                          I i)

Opens a UI to select an Tasks Dashboard Category to add the given Issue into.

Parameters:

r - a implementation specific Repository instance

i - a implementation specific Issue instance

Since:

1.85

setQueryAutoRefresh

public void setQueryAutoRefresh(R r,
                                Q q,
                                boolean autoRefresh)

Determines default auto-refresh for a given query.

Parameters:

r - a implementation specific Repository instance

q - a implementation specific Query instance

autoRefresh - determines the auto-refresh setting for a given query

Since:

1.107

editRepository

public boolean editRepository(R r,
                              String errorMessage)

Opens a UI to edit a repository.

Parameters:

r - a implementation specific Repository instance

errorMessage - an message to be show in the repository edit dialog

Returns:

true in case the repository was changed, otherwise false.

Since:

1.85

getPriorityIcons

public Image[] getPriorityIcons()

Priority icons used by default in the Tasks Dashboard sorted from the highest priority.
Use them in case you want your bugtracking plugin implementation to use the same icons as are used by default in the Tasks Dashboard, or provide a IssuePriorityProvider implementation via BugtrackingSupport.createRepository(java.lang.Object, org.netbeans.modules.bugtracking.spi.IssueStatusProvider, org.netbeans.modules.bugtracking.spi.IssueScheduleProvider, org.netbeans.modules.bugtracking.spi.IssuePriorityProvider, org.netbeans.modules.bugtracking.spi.IssueFinder)

Returns:

priority icons

Since:

1.85