Class JiraEpicReader


public class JiraEpicReader extends JiraReader
Reads Jira epics from a board based on the API user's permission.
  • Constructor Details

    • JiraEpicReader

      public JiraEpicReader(String domain, String username, String apiKey, int boardId)
      Creates a reader for the epics of the given board; domain is the Jira site's base URL.
  • Method Details

    • getDoneFilter

      public Boolean getDoneFilter()
      Indicates which epics to return: true=done, false=not done, null=all (default is all).
    • setDoneFilter

      public JiraEpicReader setDoneFilter(Boolean doneFilter)
      Indicates which epics to return: true=done, false=not done, null=all (default is all).
    • getIssuesRecord

      protected Record getIssuesRecord()
      Description copied from class: JiraReader
      Fetches the next page as a record with an isLast flag and the item array (named values unless changed by JiraReader.setRecordsFieldName(String)), or returns null to end the read.
      Specified by:
      getIssuesRecord in class JiraReader
    • addExceptionProperties

      public DataException addExceptionProperties(DataException exception)
      Description copied from class: Endpoint
      Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.
      Overrides:
      addExceptionProperties in class JiraReader