|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JiraPropertySetFactory
Provides a number of utility methods to get a handle on a property set in JIRA. Please note that this class' sole responsibility is to create a property set. It does not cache this property set internal and repeated method calls will create a new property set every time. The returned PropertySet should be referenced by the caller to avoid re-creating it every time.
Method Summary | |
---|---|
com.opensymphony.module.propertyset.PropertySet |
buildCachingDefaultPropertySet(String entityName,
boolean bulkLoad)
Returns a PropertySet for a particular entity. |
com.opensymphony.module.propertyset.PropertySet |
buildCachingPropertySet(com.opensymphony.module.propertyset.PropertySet propertySet,
boolean bulkLoad)
Returns a caching PropertySet that wraps the provided propertyset. |
com.opensymphony.module.propertyset.PropertySet |
buildCachingPropertySet(String entityName,
Long entityId,
boolean bulkLoad)
Returns a PropertySet . |
com.opensymphony.module.propertyset.PropertySet |
buildMemoryPropertySet(String entityName,
Long entityId)
Returns an in memory copy of a property set from the database. |
com.opensymphony.module.propertyset.PropertySet |
buildNoncachingPropertySet(String entityName)
Returns a PropertySet for a particular entity. |
com.opensymphony.module.propertyset.PropertySet |
buildNoncachingPropertySet(String entityName,
Long entityId)
Returns a PropertySet based on a ofbiz delegator. |
Method Detail |
---|
com.opensymphony.module.propertyset.PropertySet buildNoncachingPropertySet(String entityName)
PropertySet
for a particular entity.
Specifies a default entity id of 1. Any access (read and write) to this PropertySet will result in a DB call.
entityName
- The entity name to lookup your properties. E.g. jira.svn.plugin
PropertySet
backed by a com.opensymphony.module.propertyset.ofbiz.OFBizPropertySet
.com.opensymphony.module.propertyset.PropertySet buildNoncachingPropertySet(String entityName, Long entityId)
PropertySet
based on a ofbiz delegator.
Any access (read and write) to this PropertySet will result in a DB call.
entityName
- The entity name to lookup your properties. E.g. jira.svn.pluginentityId
- The entity id if you multiple properties per entity name. (E.g. OSUser properties per user id)
PropertySet
backed by a com.opensymphony.module.propertyset.ofbiz.OFBizPropertySet
.com.opensymphony.module.propertyset.PropertySet buildCachingDefaultPropertySet(String entityName, boolean bulkLoad)
PropertySet
for a particular entity. Entries in this set are
cached in memory for better performance. Specifies a default entity id of 1. Please note that this is a
write-through-cache, meaning that reads will be cached up, however any write will call through to the database
and invalidate the relevant cache entry.
Note that because the returned PropertySet will become stale, callers should not keep a long-lived reference to
it.
entityName
- The entity name to lookup your properties. E.g. jira.svn.pluginbulkLoad
- If true, all properties will be loaded during initialisation of the propertyset and cached
PropertySet
backed by a caching property setcom.opensymphony.module.propertyset.PropertySet buildCachingPropertySet(String entityName, Long entityId, boolean bulkLoad)
PropertySet
. Entries in this set are
cached in memory for better performance. Please note that this is a
write-through-cache, meaning that reads will be cached up, however any write will call through to the database
and invalidate the relevant cache entry.
Note that because the returned PropertySet will become stale, callers should not keep a long-lived reference to
it.
entityName
- The entity name to lookup your properties. E.g. jira.svn.pluginentityId
- The entity id if you multiple properties per entity name. (E.g. OSUser properties per user id)bulkLoad
- If true, all properties will be loaded during initialisation of the propertyset and cached
PropertySet
backed by a caching property setcom.opensymphony.module.propertyset.PropertySet buildCachingPropertySet(com.opensymphony.module.propertyset.PropertySet propertySet, boolean bulkLoad)
PropertySet
that wraps the provided propertyset.
Entries in this set are cached in memory for better performance. Please note that this is a
write-through-cache, meaning that reads will be cached up, however any write will call through to the database
and invalidate the relevant cache entry.
Note that because the returned PropertySet will become stale, callers should not keep a long-lived reference to
it.
propertySet
- A PropertySet to wrap by a caching property setbulkLoad
- If true, all properties will be loaded during initialisation of the propertyset and cached
PropertySet
backed by a caching property setcom.opensymphony.module.propertyset.PropertySet buildMemoryPropertySet(String entityName, Long entityId)
entityName
- The entity name to lookup your properties. E.g. jira.svn.pluginentityId
- The entity id if you multiple properties per entity name. (E.g. OSUser properties per user id)
PropertySet
held completely in memory. Changes will not
be written to the database.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |