com.atlassian.jira.jql.permission
Interface LiteralSanitiser

All Known Implementing Classes:

IssueLiteralSanitiser, ProjectLiteralSanitiser

public interface LiteralSanitiser

Defines how to sanitise a list of query literals.

Since:

v4.0

Nested Class Summary

static class

LiteralSanitiser.Result Dictates the result of sanitising a list of QueryLiterals.

Method Summary

LiteralSanitiser.Result

sanitiseLiterals(java.util.List<QueryLiteral> literals) Note: in general, it is possible that a literal can expand out into multiple id values.

Method Detail

sanitiseLiterals

LiteralSanitiser.Result sanitiseLiterals(java.util.List<QueryLiteral> literals)

Note: in general, it is possible that a literal can expand out into multiple id values. The strategy for handling these should be that if ALL values are sanitised, then modification should occur, but if at least one is okay then we should keep the original literal.

Parameters:

literals - the literals to sanitise; must not be null.

Returns:

the result object, which states if there was any modification, and also contains the resultant literals. Never null.