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 java.lang.Object implements Cloud
Doesn't do much. Relies on theBugInstance.XmlPropsread 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, java.util.Properties props)Invoked via reflection
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddDateSeen(BugInstance b, long when)voidaddListener(Cloud.CloudListener listener)voidaddStatusListener(Cloud.CloudStatusListener cloudStatusListener)booleanavailableForInitialization()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.voidbugFiled(BugInstance b, java.lang.Object bugLink)Note that we've initiated or completed a request to file a bug;voidbugsPopulated()Called after the bugs in the bug collection are loaded; bugs should not be synchronized before this method is calledbooleancanStoreUserAnnotation(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 itbooleanclaim(BugInstance b)Claim the bugjava.lang.StringclaimedBy(BugInstance b)Get the user who has claimed a bug; null if no one hasbooleancommunicationInitiated()Returns true if communication has already been initiated (and perhaps completed).java.net.URLfileBug(BugInstance b)BugCollectiongetBugCollection()booleangetBugIsUnassigned(BugInstance b)does the issue have an unassigned issue in the bug trackerjava.net.URLgetBugLink(BugInstance b)Get link for bug, either to file one or to view itCloud.BugFilingStatusgetBugLinkStatus(BugInstance b)get the bug filing status for a bug instancejava.lang.StringgetBugLinkType(BugInstance instance)java.lang.StringgetBugStatus(BugInstance b)A textual description of the bug status (e.g., FIX_LATER, ASSIGNED, OBSOLETE, WILL_NOT_FIX)doublegetClassificationDisagreement(BugInstance b)doublegetClassificationScore(BugInstance b)doublegetClassificationVariance(BugInstance b)java.lang.StringgetCloudName()java.lang.StringgetCloudReport(BugInstance b)java.lang.StringgetCloudReportWithoutMe(BugInstance b)Cloud.UserDesignationgetConsensusDesignation(BugInstance b)longgetFirstSeen(BugInstance b)longgetFirstSeenFromVersion(BugInstance b)IGuiCallbackgetGuiCallback()booleangetIWillFix(BugInstance b)has the user said they will fix this bugCloud.ModegetMode()Get voting modeintgetNumberReviewers(BugInstance b)CloudPlugingetPlugin()doublegetPortionObsoleteClassifications(BugInstance b)BugDesignationgetPrimaryDesignation(BugInstance b)Get the most recent BugDesignation from the current userjava.util.Collection<java.lang.String>getProjects(java.lang.String className)Get a list of names of FB projects that the given class "may be a part of." Used for filing bugs.java.util.Set<java.lang.String>getReviewers(BugInstance b)Cloud.SigninStategetSigninState()java.net.URLgetSourceLink(BugInstance b)URL to view the source for a bug instancejava.lang.StringgetSourceLinkToolTip(BugInstance b)Tool tip text for "view source" buttonjava.lang.StringgetStatusMsg()Get a status message for the cloud; information about any errors, and information about database synchronizationjava.lang.StringgetUser()java.util.DategetUserDate(BugInstance b)Cloud.UserDesignationgetUserDesignation(BugInstance b)Get the user's designation for the bugjava.lang.StringgetUserEvaluation(BugInstance b)Get free text evaluation of the buglonggetUserTimestamp(BugInstance b)Return the time the user last changed their evaluation of this bugbooleangetWillNotBeFixed(BugInstance b)has the issue been marked "will not be fixed" in a bug trackerbooleaninitialize()Attempt to initialize the cloudvoidinitiateCommunication()Initiate communication with the cloud.booleanisInCloud(BugInstance b)returns whether the bug is stored remotely or not.booleanisInitialized()Return true if the cloud has been successfully initializedbooleanisOnlineCloud()booleanisSavingSignInInformationEnabled()booleanoverallClassificationIsNotAProblem(BugInstance b)voidprintCloudSummary(java.io.PrintWriter w, java.lang.Iterable<BugInstance> bugs, java.lang.String[] packagePrefixes)voidremoveListener(Cloud.CloudListener listener)voidremoveStatusListener(Cloud.CloudStatusListener cloudStatusListener)voidsetBugLinkOnCloudAndStoreIssueDetails(BugInstance b, java.lang.String viewUrl, java.lang.String linkType)voidsetMode(Cloud.Mode m)Set voting modevoidsetSaveSignInInformation(boolean save)Whether the cloud should save login information, session ID's, etc.voidshutdown()Shutdown the cloud, note termination of session, close connectionsvoidsignIn()voidsignOut()voidstoreUserAnnotation(BugInstance bugInstance)Update user designation and evaluation from information in bug instance and push to databasebooleansupportsBugLinks()Supports links to a bug databasebooleansupportsClaims()Supports allowing users to claim a bugbooleansupportsCloudReports()Supports textual summaries about the status of a bugbooleansupportsCloudSummaries()booleansupportsSourceLinks()Does the cloud support source lines (e.g., to FishEye)voidupdateBugStatusCache(BugInstance b, java.lang.String status)Updates the local cache of bug reporting status.voidwaitUntilIssueDataDownloaded()Waits until all data about this bug collection has been received from the cloud.booleanwaitUntilIssueDataDownloaded(long timeout, java.util.concurrent.TimeUnit unit)voidwaitUntilNewIssuesUploaded()Waits until all new issues have been uploadedbooleanwaitUntilNewIssuesUploaded(long timeout, java.util.concurrent.TimeUnit unit)
-
-
-
Constructor Detail
-
DoNothingCloud
public DoNothingCloud(CloudPlugin plugin, BugCollection bc, java.util.Properties props)
Invoked via reflection
-
DoNothingCloud
public DoNothingCloud(BugCollection bc)
-
-
Method Detail
-
getPlugin
public CloudPlugin getPlugin()
-
getCloudName
public java.lang.String getCloudName()
- Specified by:
getCloudNamein interfaceCloud
-
getBugCollection
public BugCollection getBugCollection()
- Specified by:
getBugCollectionin interfaceCloud
-
getGuiCallback
public IGuiCallback getGuiCallback()
- Specified by:
getGuiCallbackin interfaceCloud
-
getStatusMsg
public java.lang.String getStatusMsg()
Description copied from interface:CloudGet a status message for the cloud; information about any errors, and information about database synchronization- Specified by:
getStatusMsgin interfaceCloud
-
printCloudSummary
public void printCloudSummary(java.io.PrintWriter w, java.lang.Iterable<BugInstance> bugs, java.lang.String[] packagePrefixes)- Specified by:
printCloudSummaryin interfaceCloud
-
addListener
public void addListener(Cloud.CloudListener listener)
- Specified by:
addListenerin interfaceCloud
-
removeListener
public void removeListener(Cloud.CloudListener listener)
- Specified by:
removeListenerin interfaceCloud
-
addStatusListener
public void addStatusListener(Cloud.CloudStatusListener cloudStatusListener)
- Specified by:
addStatusListenerin interfaceCloud
-
removeStatusListener
public void removeStatusListener(Cloud.CloudStatusListener cloudStatusListener)
- Specified by:
removeStatusListenerin interfaceCloud
-
availableForInitialization
public boolean availableForInitialization()
Description copied from interface:CloudDo 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:
availableForInitializationin interfaceCloud- Returns:
- true if we have the needed information
-
initialize
public boolean initialize()
Description copied from interface:CloudAttempt to initialize the cloud- Specified by:
initializein interfaceCloud- Returns:
- true if successful
-
waitUntilNewIssuesUploaded
public void waitUntilNewIssuesUploaded()
Description copied from interface:CloudWaits until all new issues have been uploaded- Specified by:
waitUntilNewIssuesUploadedin interfaceCloud
-
waitUntilIssueDataDownloaded
public void waitUntilIssueDataDownloaded()
Description copied from interface:CloudWaits until all data about this bug collection has been received from the cloud.- Specified by:
waitUntilIssueDataDownloadedin interfaceCloud
-
waitUntilNewIssuesUploaded
public boolean waitUntilNewIssuesUploaded(long timeout, java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException- Specified by:
waitUntilNewIssuesUploadedin interfaceCloud- Throws:
java.lang.InterruptedException
-
waitUntilIssueDataDownloaded
public boolean waitUntilIssueDataDownloaded(long timeout, java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException- Specified by:
waitUntilIssueDataDownloadedin interfaceCloud- Throws:
java.lang.InterruptedException
-
bugsPopulated
public void bugsPopulated()
Description copied from interface:CloudCalled after the bugs in the bug collection are loaded; bugs should not be synchronized before this method is called- Specified by:
bugsPopulatedin interfaceCloud
-
initiateCommunication
public void initiateCommunication()
Description copied from interface:CloudInitiate 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 toCloud.waitUntilIssueDataDownloaded(). A call to this method forces eager initiation of communication.- Specified by:
initiateCommunicationin interfaceCloud
-
shutdown
public void shutdown()
Description copied from interface:CloudShutdown the cloud, note termination of session, close connections
-
getSigninState
public Cloud.SigninState getSigninState()
- Specified by:
getSigninStatein interfaceCloud
-
setSaveSignInInformation
public void setSaveSignInInformation(boolean save)
Description copied from interface:CloudWhether the cloud should save login information, session ID's, etc. If disabled, the user will need to re-authenticate each session.- Specified by:
setSaveSignInInformationin interfaceCloud
-
isSavingSignInInformationEnabled
public boolean isSavingSignInInformationEnabled()
- Specified by:
isSavingSignInInformationEnabledin interfaceCloud
-
signIn
public void signIn() throws java.io.IOException
-
getMode
public Cloud.Mode getMode()
Description copied from interface:CloudGet voting mode
-
setMode
public void setMode(Cloud.Mode m)
Description copied from interface:CloudSet voting mode
-
supportsSourceLinks
public boolean supportsSourceLinks()
Description copied from interface:CloudDoes the cloud support source lines (e.g., to FishEye)- Specified by:
supportsSourceLinksin interfaceCloud
-
supportsBugLinks
public boolean supportsBugLinks()
Description copied from interface:CloudSupports links to a bug database- Specified by:
supportsBugLinksin interfaceCloud
-
supportsCloudReports
public boolean supportsCloudReports()
Description copied from interface:CloudSupports textual summaries about the status of a bug- Specified by:
supportsCloudReportsin interfaceCloud
-
supportsClaims
public boolean supportsClaims()
Description copied from interface:CloudSupports allowing users to claim a bug- Specified by:
supportsClaimsin interfaceCloud
-
supportsCloudSummaries
public boolean supportsCloudSummaries()
- Specified by:
supportsCloudSummariesin interfaceCloud
-
getProjects
public java.util.Collection<java.lang.String> getProjects(java.lang.String className)
Description copied from interface:CloudGet a list of names of FB projects that the given class "may be a part of." Used for filing bugs.- Specified by:
getProjectsin interfaceCloud
-
isInCloud
public boolean isInCloud(BugInstance b)
Description copied from interface:Cloudreturns whether the bug is stored remotely or not. for bug collection storage, always returns true
-
isOnlineCloud
public boolean isOnlineCloud()
- Specified by:
isOnlineCloudin interfaceCloud
-
getIWillFix
public boolean getIWillFix(BugInstance b)
Description copied from interface:Cloudhas the user said they will fix this bug- Specified by:
getIWillFixin interfaceCloud
-
getSourceLinkToolTip
public java.lang.String getSourceLinkToolTip(@CheckForNull BugInstance b)Description copied from interface:CloudTool tip text for "view source" button- Specified by:
getSourceLinkToolTipin interfaceCloud
-
getSourceLink
public java.net.URL getSourceLink(BugInstance b)
Description copied from interface:CloudURL to view the source for a bug instance- Specified by:
getSourceLinkin interfaceCloud
-
getBugLinkStatus
public Cloud.BugFilingStatus getBugLinkStatus(BugInstance b)
Description copied from interface:Cloudget the bug filing status for a bug instance- Specified by:
getBugLinkStatusin interfaceCloud
-
getBugStatus
public java.lang.String getBugStatus(BugInstance b)
Description copied from interface:CloudA textual description of the bug status (e.g., FIX_LATER, ASSIGNED, OBSOLETE, WILL_NOT_FIX)- Specified by:
getBugStatusin interfaceCloud
-
getWillNotBeFixed
public boolean getWillNotBeFixed(BugInstance b)
Description copied from interface:Cloudhas the issue been marked "will not be fixed" in a bug tracker- Specified by:
getWillNotBeFixedin interfaceCloud
-
getBugIsUnassigned
public boolean getBugIsUnassigned(BugInstance b)
Description copied from interface:Clouddoes the issue have an unassigned issue in the bug tracker- Specified by:
getBugIsUnassignedin interfaceCloud
-
getBugLink
public java.net.URL getBugLink(BugInstance b)
Description copied from interface:CloudGet link for bug, either to file one or to view it- Specified by:
getBugLinkin interfaceCloud
-
getBugLinkType
public java.lang.String getBugLinkType(BugInstance instance)
- Specified by:
getBugLinkTypein interfaceCloud
-
fileBug
public java.net.URL fileBug(BugInstance b)
-
setBugLinkOnCloudAndStoreIssueDetails
public void setBugLinkOnCloudAndStoreIssueDetails(BugInstance b, java.lang.String viewUrl, java.lang.String linkType) throws java.io.IOException, SignInCancelledException
- Specified by:
setBugLinkOnCloudAndStoreIssueDetailsin interfaceCloud- Throws:
java.io.IOExceptionSignInCancelledException
-
updateBugStatusCache
public void updateBugStatusCache(BugInstance b, java.lang.String status)
Description copied from interface:CloudUpdates the local cache of bug reporting status. Does not modify server code.- Specified by:
updateBugStatusCachein interfaceCloud
-
bugFiled
public void bugFiled(BugInstance b, @CheckForNull java.lang.Object bugLink)
Description copied from interface:CloudNote that we've initiated or completed a request to file a bug;
-
getCloudReport
public java.lang.String getCloudReport(BugInstance b)
- Specified by:
getCloudReportin interfaceCloud
-
getCloudReportWithoutMe
public java.lang.String getCloudReportWithoutMe(BugInstance b)
- Specified by:
getCloudReportWithoutMein interfaceCloud
-
claimedBy
public java.lang.String claimedBy(BugInstance b)
Description copied from interface:CloudGet the user who has claimed a bug; null if no one has
-
claim
public boolean claim(BugInstance b)
Description copied from interface:CloudClaim the bug
-
getUserTimestamp
public long getUserTimestamp(BugInstance b)
Description copied from interface:CloudReturn the time the user last changed their evaluation of this bug- Specified by:
getUserTimestampin interfaceCloud
-
getUserDate
public java.util.Date getUserDate(BugInstance b)
- Specified by:
getUserDatein interfaceCloud
-
getPrimaryDesignation
public BugDesignation getPrimaryDesignation(BugInstance b)
Description copied from interface:CloudGet the most recent BugDesignation from the current user- Specified by:
getPrimaryDesignationin interfaceCloud
-
getUserDesignation
public Cloud.UserDesignation getUserDesignation(BugInstance b)
Description copied from interface:CloudGet the user's designation for the bug- Specified by:
getUserDesignationin interfaceCloud
-
getUserEvaluation
public java.lang.String getUserEvaluation(BugInstance b)
Description copied from interface:CloudGet free text evaluation of the bug- Specified by:
getUserEvaluationin interfaceCloud
-
getClassificationScore
public double getClassificationScore(BugInstance b)
- Specified by:
getClassificationScorein interfaceCloud
-
getClassificationVariance
public double getClassificationVariance(BugInstance b)
- Specified by:
getClassificationVariancein interfaceCloud
-
getClassificationDisagreement
public double getClassificationDisagreement(BugInstance b)
- Specified by:
getClassificationDisagreementin interfaceCloud
-
getPortionObsoleteClassifications
public double getPortionObsoleteClassifications(BugInstance b)
- Specified by:
getPortionObsoleteClassificationsin interfaceCloud
-
getNumberReviewers
public int getNumberReviewers(BugInstance b)
- Specified by:
getNumberReviewersin interfaceCloud
-
getReviewers
public java.util.Set<java.lang.String> getReviewers(BugInstance b)
- Specified by:
getReviewersin interfaceCloud
-
getFirstSeen
public long getFirstSeen(BugInstance b)
- Specified by:
getFirstSeenin interfaceCloud
-
addDateSeen
public void addDateSeen(BugInstance b, long when)
- Specified by:
addDateSeenin interfaceCloud
-
getFirstSeenFromVersion
public long getFirstSeenFromVersion(BugInstance b)
-
getConsensusDesignation
public Cloud.UserDesignation getConsensusDesignation(BugInstance b)
- Specified by:
getConsensusDesignationin interfaceCloud- Returns:
Cloud.UserDesignation.UNCLASSIFIEDif no consensus has been reached
-
overallClassificationIsNotAProblem
public boolean overallClassificationIsNotAProblem(BugInstance b)
- Specified by:
overallClassificationIsNotAProblemin interfaceCloud
-
canStoreUserAnnotation
public boolean canStoreUserAnnotation(BugInstance bugInstance)
Description copied from interface:CloudIs 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:
canStoreUserAnnotationin interfaceCloud
-
storeUserAnnotation
public void storeUserAnnotation(BugInstance bugInstance)
Description copied from interface:CloudUpdate user designation and evaluation from information in bug instance and push to database- Specified by:
storeUserAnnotationin interfaceCloud
-
communicationInitiated
public boolean communicationInitiated()
Description copied from interface:CloudReturns true if communication has already been initiated (and perhaps completed).- Specified by:
communicationInitiatedin interfaceCloud
-
isInitialized
public boolean isInitialized()
Description copied from interface:CloudReturn true if the cloud has been successfully initialized- Specified by:
isInitializedin interfaceCloud
-
-