Interface Issue
-
- All Known Subinterfaces:
IssueEx
- All Known Implementing Classes:
IssueWrapper
public interface Issue
Represents an issue from the issue-tracking system.This interface is close to
IssueData
, but added for future extensibility. The issue-tracker plugins should useIssueData
class.- Since:
- 5.0
- Author:
- Maxim Podkolzine (maxim.podkolzine@jetbrains.com)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Map<String,String>
getAllFields()
Returns all issue fields as a map (unmodifiable).String
getId()
Returns the issue id.String
getPriority()
Returns the issue priority (e.g.IssueProvider
getProvider()
Returns a corresponding provider for this issue.String
getSeverity()
Returns the issue severity (e.g.String
getState()
Returns the issue state (e.g.String
getSummary()
Returns the issue summary (a single line which describes the issue briefly).String
getType()
Returns the issue type (e.g.String
getUrl()
Returns the URL corresponding to the issue.boolean
isFeatureRequest()
Returns whether the issue is a feature request (enhancement).boolean
isResolved()
Returns whether the issue is resolved (possibly as "won't fix").
-
-
-
Method Detail
-
getId
@NotNull String getId()
Returns the issue id. The id is generated by the issue tracker and is considered immutable.- Returns:
- issue id
-
getType
@NotNull String getType()
Returns the issue type (e.g. bug, feature, exception, etc). Returns an empty string if the notion of type is not applicable.- Returns:
- the issue type
- Since:
- 7.1
-
getSummary
@NotNull String getSummary()
Returns the issue summary (a single line which describes the issue briefly).- Returns:
- issue summary
-
getState
@NotNull String getState()
Returns the issue state (e.g. open, fixed, etc.). Returns an empty string if the notion of state is not applicable.- Returns:
- the issue state
-
getPriority
@NotNull String getPriority()
Returns the issue priority (e.g. P1, P2, or normal, etc.). Returns an empty string if the notion of priority is not applicable.- Returns:
- the issue priority
- Since:
- 7.1
-
getSeverity
@NotNull String getSeverity()
Returns the issue severity (e.g. normal, major, blocker, etc.). Returns an empty string if the notion of severity is not applicable.- Returns:
- the issue severity
- Since:
- 7.1
-
isResolved
boolean isResolved()
Returns whether the issue is resolved (possibly as "won't fix").- Returns:
- true if the issue is resolved
-
isFeatureRequest
boolean isFeatureRequest()
Returns whether the issue is a feature request (enhancement).- Returns:
- true if the issue is a feature request
- Since:
- 7.1
-
getAllFields
@NotNull Map<String,String> getAllFields()
Returns all issue fields as a map (unmodifiable).- Returns:
- a map of issue fields
- Since:
- 7.1
-
getUrl
@Nullable String getUrl()
Returns the URL corresponding to the issue.- Returns:
- corresponding URL
-
getProvider
@NotNull IssueProvider getProvider()
Returns a corresponding provider for this issue.- Returns:
- a corresponding provider
- Since:
- 8.0
-
-