public class

OFBizPropertyUtils

extends Object
java.lang.Object
   ↳ com.atlassian.core.ofbiz.util.OFBizPropertyUtils

Class Overview

This was taken from atlassian-ofbiz and placed into its now rightful home of JIRA.

Summary

Public Constructors
OFBizPropertyUtils()
Public Methods
static PropertySet getCachingPropertySet(String entityName, Long entityId)
Gets a caching property set that is associated with the specified entity.
static PropertySet getCachingPropertySet(GenericValue gv)
Gets a caching property set that is associated with the specified generic value.
static PropertySet getPropertySet(String entityName, Long entityId)
Gets a non-caching property set that is associated with the specified entity.
static PropertySet getPropertySet(GenericValue gv)
Gets a non-caching property set that is associated with the specified generic value.
static void removePropertySet(String entityName, Long entityId)
Implementation note: This method assumes that the property set has been accessed in a cached manner and flushes any associated entries.
static void removePropertySet(GenericValue gv)
Implementation note: This method assumes that the property set has been accessed in a cached manner and flushes any associated entries.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public OFBizPropertyUtils ()

Public Methods

public static PropertySet getCachingPropertySet (String entityName, Long entityId)

Gets a caching property set that is associated with the specified entity. This method should almost always be preferred over getPropertySet(String, Long), because this implementation will be more efficient for most cases. It is also safer to use the caching property set, because it will notify any other caching property sets if their information has become stale. The non-caching property set returned by the other method does not do this, so any caching property sets created by other code will not be notified of changes.

Parameters
entityName the entity model name of the property set's owning entity
entityId the entity ID of the property set's owning entity
Returns
  • the caching property set

public static PropertySet getCachingPropertySet (GenericValue gv)

Gets a caching property set that is associated with the specified generic value. This method should almost always be preferred over getPropertySet(GenericValue), because this implementation will be more efficient for most cases. It is also safer to use the caching property set, because it will notify any other caching property sets if their information has become stale. The non-caching property set returned by the other method does not do this, so any caching property sets created by other code will not be notified of changes.

Parameters
gv the generic value which owns the property set
Returns
  • the caching property set

public static PropertySet getPropertySet (String entityName, Long entityId)

Gets a non-caching property set that is associated with the specified entity. The getCachingPropertySet(String, Long) method should almost always be preferred over this one because that implementation will be more efficient for most cases. It is also safer to use the caching property set, because it will notify any other caching property sets if their information has become stale. The non-caching property set returned by this method does not do this, so any caching property sets created by other code will not be notified of changes.

Parameters
entityName the entity model name of the property set's owning entity
entityId the entity ID of the property set's owning entity
Returns
  • the non-caching property set

public static PropertySet getPropertySet (GenericValue gv)

Gets a non-caching property set that is associated with the specified generic value. The getCachingPropertySet(GenericValue) method should almost always be preferred over this one because that implementation will be more efficient for most cases. It is also safer to use the caching property set, because it will notify any other caching property sets if their information has become stale. The non-caching property set returned by this method does not do this, so any caching property sets created by other code will not be notified of changes.

Parameters
gv the generic value which owns the property set
Returns
  • the non-caching property set

public static void removePropertySet (String entityName, Long entityId)

Implementation note: This method assumes that the property set has been accessed in a cached manner and flushes any associated entries. If it is known in advance that there are no caching consumers of the property set, then this can be avoided by calling remove directly on the non-cached implementation: 

     getPropertySet(entityName,entityId).remove()

Parameters
entityName the entity model name of the property set's owning entity
entityId the entity ID of the property set's owning entity

public static void removePropertySet (GenericValue gv)

Implementation note: This method assumes that the property set has been accessed in a cached manner and flushes any associated entries. If it is known in advance that there are no caching consumers of the property set, then this can be avoided by calling remove directly on the non-cached implementation: 

     getPropertySet(gv).remove()

Parameters
gv the generic value which owns the property set