@PublicApi public class

JiraHelper

extends Object
java.lang.Object
   ↳ com.atlassian.jira.plugin.webfragment.model.JiraHelper
Known Direct Subclasses

@PublicApi

This class is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Summary

Public Constructors
JiraHelper()
JiraHelper(HttpServletRequest request)
JiraHelper(HttpServletRequest request, Project project)
JiraHelper(HttpServletRequest request, Project project, Map<String, Object> params)
Public Methods
boolean equals(Object o)
Map<String, Object> getContextParams()
@Nullable Project getProject()
Returns the Project in this context.
@Deprecated @Nullable Project getProjectObject()
This method is deprecated. Use getProject(). Since v6.5
String getQueryString()
Returns the query string to represent this helper.
HttpServletRequest getRequest()
int hashCode()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public JiraHelper ()

public JiraHelper (HttpServletRequest request)

public JiraHelper (HttpServletRequest request, Project project)

public JiraHelper (HttpServletRequest request, Project project, Map<String, Object> params)

Public Methods

public boolean equals (Object o)

public Map<String, Object> getContextParams ()

@Nullable public Project getProject ()

Returns the Project in this context.

Can be null.

Returns
  • the Project in this context.

@Deprecated @Nullable public Project getProjectObject ()

This method is deprecated.
Use getProject(). Since v6.5

Returns the Project in this context.

Can be null.

Returns
  • the Project in this context.

public String getQueryString ()

Returns the query string to represent this helper.

TODO: replace #project with a BrowseContext so that we can just call BrowseContext#getQueryString() instead.

Returns
  • the query string to represent this helper.

public HttpServletRequest getRequest ()

public int hashCode ()