org.kohsuke.jnt
Class JNIssueTracker

java.lang.Object
  extended by org.kohsuke.jnt.JNIssueTracker

public final class JNIssueTracker
extends Object

java.net issue tracker (IssueZilla) in one project.

Author:
Kohsuke Kawaguchi, Tomas Knappek

Nested Class Summary
 class JNIssueTracker.Action
          Action metadata
 
Method Summary
 IssueCreator createIssue()
          Gets the IssueCreator object for creating new issue
 Map<Integer,JNIssue> get(int... ids)
          Gets multiple issues at once.
 JNIssue get(int id)
          Gets the issue of the specified id.
 List<JNIssueTracker.Action> getActions(String fromState)
           
 Map<Integer,JNIssue> getAll()
          Gets all the issues in this issue tracker.
 JNIssueComponent getComponent(String name)
          Gets an issue tracker component by its name.
 Map<String,JNIssueComponent> getComponents()
          Returns the components in this issue tracker.
 Map<Integer,JNIssue> getIssuesByQuery(String queryName)
          Runs the requested stored query
 List<String> getIssueTypes()
           
 List<String> getKeywords()
           
 org.dom4j.Element getMetadata()
          Gets the issue tracker metadata
 Map<Integer,JNIssue> getMyIssues()
          Runs the default query - My issues
 List<String> getOpSystems()
           
 List<String> getPlatforms()
           
 List<String> getPriorities()
           
 Map<Integer,JNIssue> getRange(int start, int end)
          Gets multiple issues at once, by spcifying a range [start,end)
 List<String> getResolutions()
           
 List<String> getStatus()
           
 Map<Integer,JNIssue> getUpdatedIssues(Calendar start, Calendar end)
          Gets all the issues updated during the specified time span.
 Map<Integer,JNIssue> getUpdatedIssues(Date start)
          Gets all the issues updated since the given time stamp.
 Map<Integer,JNIssue> getUpdatedIssues(Date start, Date end)
           
 JNIssue load(int id, InputStream in)
          Loads the issue persisted by JNIssue.save(OutputStream).
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

get

public JNIssue get(int id)
            throws ProcessingException
Gets the issue of the specified id. For the performance reason, if you access multiple issues, it will be faster to use get(int...)

Throws:
ProcessingException

get

public Map<Integer,JNIssue> get(int... ids)
                         throws ProcessingException
Gets multiple issues at once.

Returns:
the map is from the id to JNIssue. It contains entries for all the specified IDs that actually exist. Non-existent issue ID in the argument will not be an error, but the returned map won't have entries for such IDs.
Throws:
ProcessingException

getRange

public Map<Integer,JNIssue> getRange(int start,
                                     int end)
                              throws ProcessingException
Gets multiple issues at once, by spcifying a range [start,end)

Throws:
ProcessingException

getAll

public Map<Integer,JNIssue> getAll()
                            throws ProcessingException
Gets all the issues in this issue tracker.

Throws:
ProcessingException

load

public JNIssue load(int id,
                    InputStream in)
             throws ProcessingException
Loads the issue persisted by JNIssue.save(OutputStream).

Throws:
ProcessingException

getUpdatedIssues

public Map<Integer,JNIssue> getUpdatedIssues(Calendar start,
                                             Calendar end)
                                      throws ProcessingException
Gets all the issues updated during the specified time span.

This wraps http://www.jini.org/nonav/docs/ProjectOwnerIssues.html#xml

Returns:
the map is from the id to JNIssue. It contains entries for all the specified IDs.
Throws:
ProcessingException

getUpdatedIssues

public Map<Integer,JNIssue> getUpdatedIssues(Date start,
                                             Date end)
                                      throws ProcessingException
Throws:
ProcessingException

getUpdatedIssues

public Map<Integer,JNIssue> getUpdatedIssues(Date start)
                                      throws ProcessingException
Gets all the issues updated since the given time stamp.

Throws:
ProcessingException

getMetadata

public org.dom4j.Element getMetadata()
                              throws ProcessingException
Gets the issue tracker metadata

Returns:
Throws:
ProcessingException

getIssueTypes

public List<String> getIssueTypes()
                           throws ProcessingException
Throws:
ProcessingException

getPriorities

public List<String> getPriorities()
                           throws ProcessingException
Throws:
ProcessingException

getStatus

public List<String> getStatus()
                       throws ProcessingException
Throws:
ProcessingException

getResolutions

public List<String> getResolutions()
                            throws ProcessingException
Throws:
ProcessingException

getOpSystems

public List<String> getOpSystems()
                          throws ProcessingException
Throws:
ProcessingException

getPlatforms

public List<String> getPlatforms()
                          throws ProcessingException
Throws:
ProcessingException

getKeywords

public List<String> getKeywords()
                         throws ProcessingException
Throws:
ProcessingException

getActions

public List<JNIssueTracker.Action> getActions(String fromState)
                                       throws ProcessingException
Throws:
ProcessingException

getComponents

public Map<String,JNIssueComponent> getComponents()
                                           throws ProcessingException
Returns the components in this issue tracker.

Returns:
can be empty but never null.
Throws:
ProcessingException

createIssue

public IssueCreator createIssue()
                         throws ProcessingException
Gets the IssueCreator object for creating new issue

Throws:
ProcessingException

getIssuesByQuery

public Map<Integer,JNIssue> getIssuesByQuery(String queryName)
                                      throws ProcessingException
Runs the requested stored query

Throws:
ProcessingException

getMyIssues

public Map<Integer,JNIssue> getMyIssues()
                                 throws ProcessingException
Runs the default query - My issues

Throws:
ProcessingException

getComponent

public JNIssueComponent getComponent(String name)
                              throws ProcessingException
Gets an issue tracker component by its name.

Returns:
null if not found.
Throws:
ProcessingException


Copyright © 2003-2009 Kohsuke Kawaguchi. All Rights Reserved.