Class IssueData

  • All Implemented Interfaces:
    Serializable

    public class IssueData
    extends Object
    implements Serializable
    Represents the class for the data fetched from the issue-tracker.

    The class is expected to be used by TeamCity plugins to return issue-related data. Note that TeamCity creates a wrapper around this data (that implements a more generic interface, see Issue).

    Implements Serializable to support persisting of fetched issues on disk (cache).

    Since:
    5.0
    Author:
    Maxim Podkolzine (maxim.podkolzine@jetbrains.com)
    See Also:
    Serialized Form
    • Constructor Detail

      • IssueData

        public IssueData​(@NotNull
                         String id,
                         @NotNull
                         String summary,
                         @NotNull
                         String state,
                         @NotNull
                         String url,
                         boolean resolved)
      • IssueData

        public IssueData​(@NotNull
                         String id,
                         @Nullable
                         Map<String,​String> data,
                         boolean resolved,
                         boolean featureRequest,
                         @NotNull
                         String url)
    • Method Detail

      • getId

        @NotNull
        public String getId()
        Returns the issue id. The id is generated by the issue tracker and is considered immutable.
        Returns:
        issue id
      • getType

        @NotNull
        public 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
        public String getSummary()
        Returns the issue summary (a single line which describes the issue briefly).
        Returns:
        issue summary
      • getState

        @NotNull
        public 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
        public 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
        public 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

        public boolean isResolved()
        Returns whether the issue is resolved (possibly as "won't fix").
        Returns:
        true if the issue is resolved
      • isFeatureRequest

        public 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
        public Map<String,​String> getAllFields()
        Returns all issue fields as a map (unmodifiable).
        Returns:
        a map of issue fields
        Since:
        7.1
      • getUrl

        @NotNull
        public String getUrl()
        Returns the URL corresponding to the issue.
        Returns:
        corresponding URL
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object