Task (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.tasks.Task

Direct Known Subclasses:

BugzillaTask, GenericTask, GitlabTask, JiraTask, LocalTask, MantisTask, PivotalTrackerTask, RedmineTask, TrelloTask
```
public abstract class Task
extends java.lang.Object
```

Field Summary

Fields
Modifier and Type Field and Description

static Task[] EMPTY_ARRAY

Fields
Modifier and Type	Field and Description
`static Task[]`	`EMPTY_ARRAY`

Constructor Summary

Constructors
Constructor and Description

Task()

Constructors
Constructor and Description
`Task()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`protected static java.lang.String`	`extractNumberFromId(java.lang.String id)`
`protected static java.lang.String`	`extractProjectFromId(java.lang.String id)`
`abstract Comment []`	`getComments()`
`abstract java.util.Date`	`getCreated()`
`java.lang.String`	`getCustomIcon()`
`abstract java.lang.String`	`getDescription()`
`abstract javax.swing.Icon`	`getIcon()`
`abstract java.lang.String`	`getId()` Global unique task identifier, e.g.
`abstract java.lang.String`	`getIssueUrl()`
`java.lang.String`	`getNumber()` Per-project issue identifier.
`java.lang.String`	`getPresentableId()`
`java.lang.String`	`getPresentableName()`
`java.lang.String`	`getProject()` Name of the project task belongs to.
`TaskRepository`	`getRepository()`
`TaskState`	`getState()`
`abstract java.lang.String`	`getSummary()` Short task description.
`abstract TaskType`	`getType()`
`abstract java.util.Date`	`getUpdated()`
`int`	`hashCode()`
`abstract boolean`	`isClosed()`
`abstract boolean`	`isIssue()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_ARRAY
```
public static final Task[] EMPTY_ARRAY
```
- Constructor Detail
  - Task
```
public Task()
```
- Method Detail
  - getId
```
public abstract java.lang.String getId()
```
    Global unique task identifier, e.g. IDEA-00001. It's important that its format is consistent with TaskRepository.extractId(String), because otherwise task won't be updated on its activation. Note that this ID is used to find issues and to compare them, so (ideally) it has to be unique. In some cases task server doesn't offer such global ID (but, for instance, pair (project-name, per-project-id) instead) or it's not what users want to see in UI (e.g. notorious id and iid in Gitlab). In this case you should generate artificial ID for internal usage and implement getPresentableId().
    
    Returns:
    
    unique global ID as described
    
    See Also:
    
    getPresentableId(), TaskRepository.extractId(String), TaskManager.activateTask(Task, boolean)
  - getPresentableId
```
public java.lang.String getPresentableId()
```
    Returns:
    
    ID in the form that is suitable for commit messages, dialogs, completion items, etc.
  - getSummary
```
public abstract java.lang.String getSummary()
```
    Short task description.
    
    Returns:
    
    description
  - getDescription
```
public abstract java.lang.String getDescription()
```
  - getComments
```
public abstract Comment [] getComments()
```
  - getIcon
```
public abstract javax.swing.Icon getIcon()
```
  - getType
```
public abstract TaskType getType()
```
  - getUpdated
```
public abstract java.util.Date getUpdated()
```
  - getCreated
```
public abstract java.util.Date getCreated()
```
  - isClosed
```
public abstract boolean isClosed()
```
  - getCustomIcon
```
public java.lang.String getCustomIcon()
```
  - isIssue
```
public abstract boolean isIssue()
```
    Returns:
    
    true if bugtracking issue is associated
  - getIssueUrl
```
public abstract java.lang.String getIssueUrl()
```
  - getRepository
```
public TaskRepository getRepository()
```
    Returns:
    
    null if no issue is associated
    
    See Also:
    
    isIssue()
  - getState
```
public TaskState getState()
```
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getPresentableName
```
public java.lang.String getPresentableName()
```
  - equals
```
public final boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getNumber
```
public java.lang.String getNumber()
```
    Per-project issue identifier. Default behavior is to extract project name from task's ID. If your service doesn't provide issue ID in format PROJECT-123 be sure to initialize it manually, as it will be used to format commit messages.
    
    Returns:
    
    project-wide issue identifier
    
    See Also:
    
    getId(), TaskRepository.getCommitMessageFormat()
  - extractNumberFromId
```
protected static java.lang.String extractNumberFromId(java.lang.String id)
```
  - getProject
```
public java.lang.String getProject()
```
    Name of the project task belongs to. Default behavior is to extract project name from task's ID. If your service doesn't provide issue ID in format PROJECT-123 be sure to initialize it manually, as it will be used to format commit messages.
    
    Returns:
    
    name of the project
    
    See Also:
    
    getId(), TaskRepository.getCommitMessageFormat()
  - extractProjectFromId
```
protected static java.lang.String extractProjectFromId(java.lang.String id)
```

Class Task

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_ARRAY

Constructor Detail

Task

Method Detail

getId

getPresentableId

getSummary

getDescription

getComments

getIcon

getType

getUpdated

getCreated

isClosed

getCustomIcon

isIssue

getIssueUrl

getRepository

getState

toString

getPresentableName

equals

hashCode

getNumber

extractNumberFromId

getProject

extractProjectFromId