Package edu.umd.cs.findbugs.cloud

Class DoNothingCloud

java.lang.Object

edu.umd.cs.findbugs.cloud.DoNothingCloud

All Implemented Interfaces:

Cloud

public class DoNothingCloud
extends Object
implements Cloud

Doesn't do much. Relies on the BugInstance.XmlProps read from the analysis XML file, if present.

Nested Class Summary

Nested classes/interfaces inherited from interface edu.umd.cs.findbugs.cloud.Cloud

Cloud.BugFilingStatus, Cloud.CloudListener, Cloud.CloudStatusListener, Cloud.CloudTask, Cloud.CloudTaskListener, Cloud.Mode, Cloud.SigninState, Cloud.UserDesignation

Constructor Summary

Constructors

Constructor	Description
DoNothingCloud(BugCollection bc)
DoNothingCloud(CloudPlugin plugin, BugCollection bc, Properties props)	Invoked via reflection

Method Summary

Modifier and Type	Method	Description
void	addDateSeen(BugInstance b, long when)
void	addListener(Cloud.CloudListener listener)
void	addStatusListener(Cloud.CloudStatusListener cloudStatusListener)
boolean	availableForInitialization()	Do we have the configuration information needed to try initializing the cloud; calling this method should have no side effects and not display any dialogs or make any network connections.
void	bugFiled(BugInstance b, Object bugLink)	Note that we've initiated or completed a request to file a bug;
void	bugsPopulated()	Called after the bugs in the bug collection are loaded; bugs should not be synchronized before this method is called
boolean	canStoreUserAnnotation(BugInstance bugInstance)	Is this bug one that gets persisted to the cloud? We may decide that we don't persist low confidence issues to the database to avoid overloading it
boolean	claim(BugInstance b)	Claim the bug
String	claimedBy(BugInstance b)	Get the user who has claimed a bug; null if no one has
boolean	communicationInitiated()	Returns true if communication has already been initiated (and perhaps completed).
URL	fileBug(BugInstance b)
BugCollection	getBugCollection()
boolean	getBugIsUnassigned(BugInstance b)	does the issue have an unassigned issue in the bug tracker
URL	getBugLink(BugInstance b)	Get link for bug, either to file one or to view it
Cloud.BugFilingStatus	getBugLinkStatus(BugInstance b)	get the bug filing status for a bug instance
String	getBugLinkType(BugInstance instance)
String	getBugStatus(BugInstance b)	A textual description of the bug status (e.g., FIX_LATER, ASSIGNED, OBSOLETE, WILL_NOT_FIX)
double	getClassificationDisagreement(BugInstance b)
double	getClassificationScore(BugInstance b)
double	getClassificationVariance(BugInstance b)
String	getCloudName()
String	getCloudReport(BugInstance b)
String	getCloudReportWithoutMe(BugInstance b)
Cloud.UserDesignation	getConsensusDesignation(BugInstance b)
long	getFirstSeen(BugInstance b)
long	getFirstSeenFromVersion(BugInstance b)
IGuiCallback	getGuiCallback()
boolean	getIWillFix(BugInstance b)	has the user said they will fix this bug
Cloud.Mode	getMode()	Get voting mode
int	getNumberReviewers(BugInstance b)
CloudPlugin	getPlugin()
double	getPortionObsoleteClassifications(BugInstance b)
BugDesignation	getPrimaryDesignation(BugInstance b)	Get the most recent BugDesignation from the current user
Collection<String>	getProjects(String className)	Get a list of names of FB projects that the given class "may be a part of." Used for filing bugs.
Set<String>	getReviewers(BugInstance b)
Cloud.SigninState	getSigninState()
URL	getSourceLink(BugInstance b)	URL to view the source for a bug instance
String	getSourceLinkToolTip(BugInstance b)	Tool tip text for "view source" button
String	getStatusMsg()	Get a status message for the cloud; information about any errors, and information about database synchronization
String	getUser()
Date	getUserDate(BugInstance b)
Cloud.UserDesignation	getUserDesignation(BugInstance b)	Get the user's designation for the bug
String	getUserEvaluation(BugInstance b)	Get free text evaluation of the bug
long	getUserTimestamp(BugInstance b)	Return the time the user last changed their evaluation of this bug
boolean	getWillNotBeFixed(BugInstance b)	has the issue been marked "will not be fixed" in a bug tracker
boolean	initialize()	Attempt to initialize the cloud
void	initiateCommunication()	Initiate communication with the cloud.
boolean	isInCloud(BugInstance b)	returns whether the bug is stored remotely or not.
boolean	isInitialized()	Return true if the cloud has been successfully initialized
boolean	isOnlineCloud()
boolean	isSavingSignInInformationEnabled()
boolean	overallClassificationIsNotAProblem(BugInstance b)
void	printCloudSummary(PrintWriter w, Iterable<BugInstance> bugs, String[] packagePrefixes)
void	removeListener(Cloud.CloudListener listener)
void	removeStatusListener(Cloud.CloudStatusListener cloudStatusListener)
void	setBugLinkOnCloudAndStoreIssueDetails(BugInstance b, String viewUrl, String linkType)
void	setMode(Cloud.Mode m)	Set voting mode
void	setSaveSignInInformation(boolean save)	Whether the cloud should save login information, session ID's, etc.
void	shutdown()	Shutdown the cloud, note termination of session, close connections
void	signIn()
void	signOut()
void	storeUserAnnotation(BugInstance bugInstance)	Update user designation and evaluation from information in bug instance and push to database
boolean	supportsBugLinks()	Supports links to a bug database
boolean	supportsClaims()	Supports allowing users to claim a bug
boolean	supportsCloudReports()	Supports textual summaries about the status of a bug
boolean	supportsCloudSummaries()
boolean	supportsSourceLinks()	Does the cloud support source lines (e.g., to FishEye)
void	updateBugStatusCache(BugInstance b, String status)	Updates the local cache of bug reporting status.
void	waitUntilIssueDataDownloaded()	Waits until all data about this bug collection has been received from the cloud.
boolean	waitUntilIssueDataDownloaded(long timeout, TimeUnit unit)
void	waitUntilNewIssuesUploaded()	Waits until all new issues have been uploaded
boolean	waitUntilNewIssuesUploaded(long timeout, TimeUnit unit)

Methods inherited from class java.lang.Object

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

Constructor Details

DoNothingCloud

public DoNothingCloud(CloudPlugin plugin,
 BugCollection bc,
 Properties props)

Invoked via reflection

DoNothingCloud

public DoNothingCloud(BugCollection bc)

Method Details

getPlugin

public CloudPlugin getPlugin()

Specified by:

getPlugin in interface Cloud

getCloudName

public String getCloudName()

Specified by:

getCloudName in interface Cloud

getBugCollection

public BugCollection getBugCollection()

Specified by:

getBugCollection in interface Cloud

getGuiCallback

public IGuiCallback getGuiCallback()

Specified by:

getGuiCallback in interface Cloud

getStatusMsg

public String getStatusMsg()

Description copied from interface: Cloud

Get a status message for the cloud; information about any errors, and information about database synchronization

Specified by:

getStatusMsg in interface Cloud

printCloudSummary

public void printCloudSummary(PrintWriter w,
 Iterable<BugInstance> bugs,
 String[] packagePrefixes)

Specified by:

printCloudSummary in interface Cloud

addListener

public void addListener(Cloud.CloudListener listener)

Specified by:

addListener in interface Cloud

removeListener

public void removeListener(Cloud.CloudListener listener)

Specified by:

removeListener in interface Cloud

addStatusListener

public void addStatusListener(Cloud.CloudStatusListener cloudStatusListener)

Specified by:

addStatusListener in interface Cloud

removeStatusListener

public void removeStatusListener(Cloud.CloudStatusListener cloudStatusListener)

Specified by:

removeStatusListener in interface Cloud

availableForInitialization

public boolean availableForInitialization()

Description copied from interface: Cloud

Do we have the configuration information needed to try initializing the cloud; calling this method should have no side effects and not display any dialogs or make any network connections.

Specified by:

availableForInitialization in interface Cloud

Returns:

true if we have the needed information

initialize

public boolean initialize()

Description copied from interface: Cloud

Attempt to initialize the cloud

Specified by:

initialize in interface Cloud

Returns:

true if successful

waitUntilNewIssuesUploaded

public void waitUntilNewIssuesUploaded()

Description copied from interface: Cloud

Waits until all new issues have been uploaded

Specified by:

waitUntilNewIssuesUploaded in interface Cloud

waitUntilIssueDataDownloaded

public void waitUntilIssueDataDownloaded()

Description copied from interface: Cloud

Waits until all data about this bug collection has been received from the cloud.

Specified by:

waitUntilIssueDataDownloaded in interface Cloud

waitUntilNewIssuesUploaded

public boolean waitUntilNewIssuesUploaded(long timeout,
 TimeUnit unit)
                                   throws InterruptedException

Specified by:

waitUntilNewIssuesUploaded in interface Cloud

Throws:

InterruptedException

waitUntilIssueDataDownloaded

public boolean waitUntilIssueDataDownloaded(long timeout,
 TimeUnit unit)
                                     throws InterruptedException

Specified by:

waitUntilIssueDataDownloaded in interface Cloud

Throws:

InterruptedException

bugsPopulated

public void bugsPopulated()

Description copied from interface: Cloud

Called after the bugs in the bug collection are loaded; bugs should not be synchronized before this method is called

Specified by:

bugsPopulated in interface Cloud

initiateCommunication

public void initiateCommunication()

Description copied from interface: Cloud

Initiate communication with the cloud. Clouds can implement lazy communication, where they don't initiate communication with the cloud until a request for cloud data is seen, or a call is made to Cloud.waitUntilIssueDataDownloaded(). A call to this method forces eager initiation of communication.

Specified by:

initiateCommunication in interface Cloud

shutdown

public void shutdown()

Description copied from interface: Cloud

Shutdown the cloud, note termination of session, close connections

Specified by:

shutdown in interface Cloud

getUser

public String getUser()

Specified by:

getUser in interface Cloud

getSigninState

public Cloud.SigninState getSigninState()

Specified by:

getSigninState in interface Cloud

setSaveSignInInformation

public void setSaveSignInInformation(boolean save)

Description copied from interface: Cloud

Whether the cloud should save login information, session ID's, etc. If disabled, the user will need to re-authenticate each session.

Specified by:

setSaveSignInInformation in interface Cloud

isSavingSignInInformationEnabled

public boolean isSavingSignInInformationEnabled()

Specified by:

isSavingSignInInformationEnabled in interface Cloud

signIn

public void signIn()
            throws IOException

Specified by:

signIn in interface Cloud

Throws:

IOException

signOut

public void signOut()

Specified by:

signOut in interface Cloud

getMode

public Cloud.Mode getMode()

Description copied from interface: Cloud

Get voting mode

Specified by:

getMode in interface Cloud

setMode

public void setMode(Cloud.Mode m)

Description copied from interface: Cloud

Set voting mode

Specified by:

setMode in interface Cloud

supportsSourceLinks

public boolean supportsSourceLinks()

Description copied from interface: Cloud

Does the cloud support source lines (e.g., to FishEye)

Specified by:

supportsSourceLinks in interface Cloud

supportsBugLinks

public boolean supportsBugLinks()

Description copied from interface: Cloud

Supports links to a bug database

Specified by:

supportsBugLinks in interface Cloud

supportsCloudReports

public boolean supportsCloudReports()

Description copied from interface: Cloud

Supports textual summaries about the status of a bug

Specified by:

supportsCloudReports in interface Cloud

supportsClaims

public boolean supportsClaims()

Description copied from interface: Cloud

Supports allowing users to claim a bug

Specified by:

supportsClaims in interface Cloud

supportsCloudSummaries

public boolean supportsCloudSummaries()

Specified by:

supportsCloudSummaries in interface Cloud

getProjects

public Collection<String> getProjects(String className)

Description copied from interface: Cloud

Get a list of names of FB projects that the given class "may be a part of." Used for filing bugs.

Specified by:

getProjects in interface Cloud

isInCloud

public boolean isInCloud(BugInstance b)

Description copied from interface: Cloud

returns whether the bug is stored remotely or not. for bug collection storage, always returns true

Specified by:

isInCloud in interface Cloud

isOnlineCloud

public boolean isOnlineCloud()

Specified by:

isOnlineCloud in interface Cloud

getIWillFix

public boolean getIWillFix(BugInstance b)

Description copied from interface: Cloud

has the user said they will fix this bug

Specified by:

getIWillFix in interface Cloud

getSourceLinkToolTip

public String getSourceLinkToolTip(@CheckForNull
 BugInstance b)

Description copied from interface: Cloud

Tool tip text for "view source" button

Specified by:

getSourceLinkToolTip in interface Cloud

getSourceLink

public URL getSourceLink(BugInstance b)

Description copied from interface: Cloud

URL to view the source for a bug instance

Specified by:

getSourceLink in interface Cloud

getBugLinkStatus

public Cloud.BugFilingStatus getBugLinkStatus(BugInstance b)

Description copied from interface: Cloud

get the bug filing status for a bug instance

Specified by:

getBugLinkStatus in interface Cloud

getBugStatus

public String getBugStatus(BugInstance b)

Description copied from interface: Cloud

A textual description of the bug status (e.g., FIX_LATER, ASSIGNED, OBSOLETE, WILL_NOT_FIX)

Specified by:

getBugStatus in interface Cloud

getWillNotBeFixed

public boolean getWillNotBeFixed(BugInstance b)

Description copied from interface: Cloud

has the issue been marked "will not be fixed" in a bug tracker

Specified by:

getWillNotBeFixed in interface Cloud

getBugIsUnassigned

public boolean getBugIsUnassigned(BugInstance b)

Description copied from interface: Cloud

does the issue have an unassigned issue in the bug tracker

Specified by:

getBugIsUnassigned in interface Cloud

getBugLink

public URL getBugLink(BugInstance b)

Description copied from interface: Cloud

Get link for bug, either to file one or to view it

Specified by:

getBugLink in interface Cloud

getBugLinkType

public String getBugLinkType(BugInstance instance)

Specified by:

getBugLinkType in interface Cloud

fileBug

public URL fileBug(BugInstance b)

Specified by:

fileBug in interface Cloud

setBugLinkOnCloudAndStoreIssueDetails

public void setBugLinkOnCloudAndStoreIssueDetails(BugInstance b,
 String viewUrl,
 String linkType)
                                           throws IOException,
SignInCancelledException

Specified by:

setBugLinkOnCloudAndStoreIssueDetails in interface Cloud

Throws:

IOException

SignInCancelledException

updateBugStatusCache

public void updateBugStatusCache(BugInstance b,
 String status)

Description copied from interface: Cloud

Updates the local cache of bug reporting status. Does not modify server code.

Specified by:

updateBugStatusCache in interface Cloud

bugFiled

public void bugFiled(BugInstance b,
 @CheckForNull
 Object bugLink)

Description copied from interface: Cloud

Note that we've initiated or completed a request to file a bug;

Specified by:

bugFiled in interface Cloud

Parameters:

b - bug against which bug was filed

bugLink - if we have any information about the result of filing the bug, it should go here

getCloudReport

public String getCloudReport(BugInstance b)

Specified by:

getCloudReport in interface Cloud

getCloudReportWithoutMe

public String getCloudReportWithoutMe(BugInstance b)

Specified by:

getCloudReportWithoutMe in interface Cloud

claimedBy

public String claimedBy(BugInstance b)

Description copied from interface: Cloud

Get the user who has claimed a bug; null if no one has

Specified by:

claimedBy in interface Cloud

claim

public boolean claim(BugInstance b)

Description copied from interface: Cloud

Claim the bug

Specified by:

claim in interface Cloud

Returns:

true if no one else has already done so

getUserTimestamp

public long getUserTimestamp(BugInstance b)

Description copied from interface: Cloud

Return the time the user last changed their evaluation of this bug

Specified by:

getUserTimestamp in interface Cloud

getUserDate

public Date getUserDate(BugInstance b)

Specified by:

getUserDate in interface Cloud

getPrimaryDesignation

public BugDesignation getPrimaryDesignation(BugInstance b)

Description copied from interface: Cloud

Get the most recent BugDesignation from the current user

Specified by:

getPrimaryDesignation in interface Cloud

getUserDesignation

public Cloud.UserDesignation getUserDesignation(BugInstance b)

Description copied from interface: Cloud

Get the user's designation for the bug

Specified by:

getUserDesignation in interface Cloud

getUserEvaluation

public String getUserEvaluation(BugInstance b)

Description copied from interface: Cloud

Get free text evaluation of the bug

Specified by:

getUserEvaluation in interface Cloud

getClassificationScore

public double getClassificationScore(BugInstance b)

Specified by:

getClassificationScore in interface Cloud

getClassificationVariance

public double getClassificationVariance(BugInstance b)

Specified by:

getClassificationVariance in interface Cloud

getClassificationDisagreement

public double getClassificationDisagreement(BugInstance b)

Specified by:

getClassificationDisagreement in interface Cloud

getPortionObsoleteClassifications

public double getPortionObsoleteClassifications(BugInstance b)

Specified by:

getPortionObsoleteClassifications in interface Cloud

getNumberReviewers

public int getNumberReviewers(BugInstance b)

Specified by:

getNumberReviewers in interface Cloud

getReviewers

public Set<String> getReviewers(BugInstance b)

Specified by:

getReviewers in interface Cloud

getFirstSeen

public long getFirstSeen(BugInstance b)

Specified by:

getFirstSeen in interface Cloud

addDateSeen

public void addDateSeen(BugInstance b,
 long when)

Specified by:

addDateSeen in interface Cloud

getFirstSeenFromVersion

public long getFirstSeenFromVersion(BugInstance b)

getConsensusDesignation

public Cloud.UserDesignation getConsensusDesignation(BugInstance b)

Specified by:

getConsensusDesignation in interface Cloud

Returns:

Cloud.UserDesignation.UNCLASSIFIED if no consensus has been reached

overallClassificationIsNotAProblem

public boolean overallClassificationIsNotAProblem(BugInstance b)

Specified by:

overallClassificationIsNotAProblem in interface Cloud

canStoreUserAnnotation

public boolean canStoreUserAnnotation(BugInstance bugInstance)

Description copied from interface: Cloud

Is this bug one that gets persisted to the cloud? We may decide that we don't persist low confidence issues to the database to avoid overloading it

Specified by:

canStoreUserAnnotation in interface Cloud

storeUserAnnotation

public void storeUserAnnotation(BugInstance bugInstance)

Description copied from interface: Cloud

Update user designation and evaluation from information in bug instance and push to database

Specified by:

storeUserAnnotation in interface Cloud

communicationInitiated

public boolean communicationInitiated()

Description copied from interface: Cloud

Returns true if communication has already been initiated (and perhaps completed).

Specified by:

communicationInitiated in interface Cloud

isInitialized

public boolean isInitialized()

Description copied from interface: Cloud

Return true if the cloud has been successfully initialized

Specified by:

isInitialized in interface Cloud