Package com.almworks.jira.structure.api.property

Interface StructurePropertyService

public interface StructurePropertyService

Holds properties associated with the particular structure

Method Summary

Modifier and Type	Method	Description
Set<String>	getAllKeys(long structureId)
default long	getLong(long structureId, String key, long defaultValue)
String	getString(long structureId, String key, String defaultValue)
void	removeAllProperties(long structureId)
default void	setValue(long structureId, String key, long value)
void	setValue(long structureId, String key, String value)	Stores value for the given structure and key Notes: 1.

Method Details

getString

@Nullable
String getString(long structureId,
 @NotNull
 String key,
 @Nullable
 String defaultValue)

getLong

default long getLong(long structureId,
 @NotNull
 String key,
 long defaultValue)

setValue

void setValue(long structureId,
 @NotNull
 String key,
 @Nullable
 String value)

Stores value for the given structure and key Notes: 1. There is no structure existence or permissions checks 2. Existing values will be overridden 3. setting 'null' will remove database entry

Parameters:

structureId - id of the structure, structure may not exist

key - should be <= 170 chars in length

value - length is not limited, but specific DB rules for storing long text values may apply

setValue

default void setValue(long structureId,
 @NotNull
 String key,
 long value)

getAllKeys

@NotNull
Set<String> getAllKeys(long structureId)

removeAllProperties

void removeAllProperties(long structureId)