com.atlassian.jira.plugin.jql.function.ClauseSanitisingJqlFunction |
Known Indirect Subclasses
AbstractVersionsFunction,
AllReleasedVersionsFunction,
AllUnreleasedVersionsFunction,
EarliestUnreleasedVersionFunction,
LatestReleasedVersionFunction,
LinkedIssuesFunction
|
Clients of @PublicSpi
can expect
that programs compiled against a given version will remain binary compatible with later versions of the
@PublicSpi
as per each product's API policy (clients should refer to each product's API policy for
the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).
@PublicSpi
interfaces and classes are specifically designed to be implemented/extended by clients.
Hence, the guarantee of binary compatibility is different to that of @PublicApi
elements (if an element
is both @PublicApi
and @PublicSpi
, both guarantees apply).
An additional interface which can be implemented by JqlFunction
classes in order to indicate to the JqlOperandResolver
that their arguments
are able to be sanitised if necessary.
This was not added to the JqlFunction
interface as the default
behaviour is not to care about sanitising, and we didn't want to bloat the plugin point.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Sanitise a function operand for the specified user, so that information is not leaked.
|
Sanitise a function operand for the specified user, so that information is not leaked.
searcher | the user performing the search |
---|---|
operand | the operand to sanitise; will only be sanitised if valid |