com.atlassian.jira.propertyset

Class BootstrapOfBizPropertyEntryStore

java.lang.Object

com.atlassian.jira.propertyset.BootstrapOfBizPropertyEntryStore

All Implemented Interfaces:

OfBizPropertyEntryStore

@ParametersAreNonnullByDefault
public class BootstrapOfBizPropertyEntryStore
extends Object
implements OfBizPropertyEntryStore

Used during bootstrap, only. This simply delegates to "ofbiz" + "cached" PropertySet combinations instead of implementing the low-level database access that "ofbiz-cached" PropertySet would normally get.

Since:

v6.2

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.jira.propertyset.OfBizPropertyEntryStore

OfBizPropertyEntryStore.PropertyEntry

Constructor Summary

Constructors

Constructor and Description
BootstrapOfBizPropertyEntryStore()

Method Summary

Modifier and Type	Method and Description
boolean	exists(String entityName, long entityId, String propertyKey) Queries whether or not the specified property exists
OfBizPropertyEntryStore.PropertyEntry	getEntry(String entityName, long entityId, String propertyKey) Retrieve the type and value of the specified property.
Collection<String>	getKeys(String entityName, long entityId) Retrieve all keys that are stored in the given property set.
Collection<String>	getKeys(String entityName, long entityId, int type) Retrieve all keys that are stored in the given property set and have the specified value type.
int	getType(String entityName, long entityId, String propertyKey) Queries the type of the specified property, if it exists.
void	removeEntry(String entityName, long entityId, String propertyKey) Remove a specific property from a property set.
void	removePropertySet(String entityName, long entityId) Remove all properties that belong to a property set.
void	setEntry(String entityName, long entityId, String propertyKey, int type, Object value) Stores a new value for the specified property.

Methods inherited from class java.lang.Object

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

Constructor Detail

BootstrapOfBizPropertyEntryStore

public BootstrapOfBizPropertyEntryStore()

Method Detail

getKeys

@Nonnull
public Collection<String> getKeys(String entityName,
                                           long entityId)

Description copied from interface: OfBizPropertyEntryStore

Retrieve all keys that are stored in the given property set.

Specified by:

getKeys in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

Returns:

all of the keys that are stored for this property set, in no particular order

getKeys

@Nonnull
public Collection<String> getKeys(String entityName,
                                           long entityId,
                                           int type)

Description copied from interface: OfBizPropertyEntryStore

Retrieve all keys that are stored in the given property set and have the specified value type.

Specified by:

getKeys in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

type - the value type, as defined by the value constants in the PropertySet interface, that the keys must have to be returned

Returns:

all of the keys that are stored for this property set and have the given type, in no particular order

exists

public boolean exists(String entityName,
                      long entityId,
                      String propertyKey)

Description copied from interface: OfBizPropertyEntryStore

Queries whether or not the specified property exists

Specified by:

exists in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

propertyKey - the name of the property to check

Returns:

whether or not the property exists

getType

public int getType(String entityName,
                   long entityId,
                   String propertyKey)

Description copied from interface: OfBizPropertyEntryStore

Queries the type of the specified property, if it exists.

Specified by:

getType in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

propertyKey - the name of the property for which to retrieve the type

Returns:

the property set entry's type, or 0 if the property does not exist

getEntry

@Nullable
public OfBizPropertyEntryStore.PropertyEntry getEntry(String entityName,
                                                                long entityId,
                                                                String propertyKey)

Description copied from interface: OfBizPropertyEntryStore

Retrieve the type and value of the specified property.

Specified by:

getEntry in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

propertyKey - the name of the property to load

Returns:

the property entry, or null if the property does not exist. Note that even if it does "exist", the value can itself be null.

setEntry

public void setEntry(String entityName,
                     long entityId,
                     String propertyKey,
                     int type,
                     Object value)

Description copied from interface: OfBizPropertyEntryStore

Stores a new value for the specified property.

Specified by:

setEntry in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

propertyKey - the name of the property to store

type - the value type that is to be stored, as defined by the value constants in the PropertySet interface.

value - the value to be stored. WARNINGSpecifying null may be tolerated for specific types, but it is generally not supported and can possibly have inconsistent results. Use OfBizPropertyEntryStore.removeEntry(String, long, String), instead.

removeEntry

public void removeEntry(String entityName,
                        long entityId,
                        String propertyKey)

Description copied from interface: OfBizPropertyEntryStore

Remove a specific property from a property set.

Specified by:

removeEntry in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner

propertyKey - the name of the property to remove

removePropertySet

public void removePropertySet(String entityName,
                              long entityId)

Description copied from interface: OfBizPropertyEntryStore

Remove all properties that belong to a property set.

Specified by:

removePropertySet in interface OfBizPropertyEntryStore

Parameters:

entityName - the entity name of the property set's owner

entityId - the entity ID of the property set's owner