@PublicApi public abstract class

AbstractEntityPropertyConditionHelper

extends Object
implements EntityPropertyConditionHelper
java.lang.Object
   ↳ com.atlassian.jira.entity.property.AbstractEntityPropertyConditionHelper<T extends com.atlassian.jira.entity.WithId>
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).

Class Overview

Base class for entity property conditions.

Summary

Protected Constructors
AbstractEntityPropertyConditionHelper(EntityPropertyService<T> propertyService, Class<T> propertyEntityType, String entityName)
Public Methods
Optional<Long> getEntityId(JiraWebContext context)
This implementation expects to find the entity of the class T in the context by the "entityName" key.
final String getEntityName()
final EntityPropertyService.PropertyResult getProperty(ApplicationUser user, Long entityId, String propertyKey)
Returns the entity property for the given and .
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.entity.property.EntityPropertyConditionHelper

Protected Constructors

protected AbstractEntityPropertyConditionHelper (EntityPropertyService<T> propertyService, Class<T> propertyEntityType, String entityName)

Public Methods

public Optional<Long> getEntityId (JiraWebContext context)

This implementation expects to find the entity of the class T in the context by the "entityName" key. ID is then taken directly from this entity.

Parameters
context - context of the web element for which the condition is evaluated.
Returns
  • ID of the entity taken from context or empty.

public final String getEntityName ()

public final EntityPropertyService.PropertyResult getProperty (ApplicationUser user, Long entityId, String propertyKey)

Returns the entity property for the given and .

Parameters
user - authenticated user, who retrieves the property.
entityId - id of the entity.
propertyKey - key of the property to retrieve.
Returns
  • the property of invalid if the property does not exist.