com.atlassian.core.ofbiz.util

Class OFBizPropertyUtils

java.lang.Object

com.atlassian.core.ofbiz.util.OFBizPropertyUtils

public class OFBizPropertyUtils
extends Object

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

Since:

4.3

Constructor Summary

Constructors

Constructor and Description
OFBizPropertyUtils()

Method Summary

Modifier and Type	Method and Description
static com.opensymphony.module.propertyset.PropertySet	getCachingPropertySet(org.ofbiz.core.entity.GenericValue gv) Gets a caching property set that is associated with the specified generic value.
static com.opensymphony.module.propertyset.PropertySet	getCachingPropertySet(String entityName, Long entityId) Gets a caching property set that is associated with the specified entity.
static com.opensymphony.module.propertyset.PropertySet	getPropertySet(org.ofbiz.core.entity.GenericValue gv) Gets a non-caching property set that is associated with the specified generic value.
static com.opensymphony.module.propertyset.PropertySet	getPropertySet(String entityName, Long entityId) Gets a non-caching property set that is associated with the specified entity.
static void	removePropertySet(org.ofbiz.core.entity.GenericValue gv) Implementation note: This method assumes that the property set has been accessed in a cached manner and flushes any associated entries.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OFBizPropertyUtils

public OFBizPropertyUtils()

Method Detail

getPropertySet

public static com.opensymphony.module.propertyset.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

Since:

6.2

getPropertySet

public static com.opensymphony.module.propertyset.PropertySet getPropertySet(org.ofbiz.core.entity.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

getCachingPropertySet

public static com.opensymphony.module.propertyset.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

Since:

6.2

getCachingPropertySet

public static com.opensymphony.module.propertyset.PropertySet getCachingPropertySet(org.ofbiz.core.entity.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

removePropertySet

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

Since:

6.2

removePropertySet

public static void removePropertySet(org.ofbiz.core.entity.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