com.atlassian.jira.propertyset

Interface OfBizPropertyEntryStore

All Known Implementing Classes:

BootstrapOfBizPropertyEntryStore, CachingOfBizPropertyEntryStore, ComponentCachingOfBizPropertyEntryStore, MockOfBizPropertyEntryStore, SingleEntityCachingOfBizPropertyEntryStore

@ParametersAreNonnullByDefault
public interface OfBizPropertyEntryStore

Cached loader for property set entries and their values. Note that this class must be used on any access to the property set to ensure cache consistency; accessing one directly using OFBizPropertySet will result in invalid cached state.

Since:

v6.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	OfBizPropertyEntryStore.PropertyEntry Holds the type and value of a property.

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.

Method Detail

getKeys

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

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

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
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.

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

getEntry

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

Retrieve the type and value of the specified property.

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.

exists

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

Queries whether or not the specified property exists

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

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

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

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

setEntry

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

Stores a new value for the specified property.

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 removeEntry(String, long, String), instead.

removeEntry

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

Remove a specific property from a property set.

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

void removePropertySet(String entityName,
                       long entityId)

Remove all properties that belong to a property set.

Parameters:

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

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