com.atlassian.confluence.impl.user.propertyset

Interface UserPropertySetDao

All Known Implementing Classes:

SqlUserPropertySetDao

public interface UserPropertySetDao

Defines an improved interface (over HibernatePropertySetDAO) for efficiently transferring items between property set abstractions and the underlying data store.

This is heavily influenced by the realities of PropertySet; implementations are expected to throw IllegalPropertyException and DuplicatePropertyKeyException where appropriate, and wrap general failures in PropertyImplementationException.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_STRING_VALUE_LENGTH

Method Summary

Modifier and Type	Method and Description
Map<String,com.atlassian.confluence.impl.user.propertyset.TaggedValue>	getItems(ConfluenceUser user)
void	removeItem(ConfluenceUser user, String key)
void	setBoolean(ConfluenceUser user, String key, boolean value)
void	setDate(ConfluenceUser user, String key, Date value)
void	setDouble(ConfluenceUser user, String key, double value)
void	setInt(ConfluenceUser user, String key, int value)
void	setLong(ConfluenceUser user, String key, long value)
void	setString(ConfluenceUser user, String key, String value)
void	setText(ConfluenceUser user, String key, String value)

Field Detail

MAX_STRING_VALUE_LENGTH

static final int MAX_STRING_VALUE_LENGTH

See Also:

Constant Field Values

Method Detail

getItems

Map<String,com.atlassian.confluence.impl.user.propertyset.TaggedValue> getItems(ConfluenceUser user)
                                                                         throws com.opensymphony.module.propertyset.PropertyException

Returns:

mutable map (so property set abstractions can use the result as a cache without first making a copy)

Throws:

com.opensymphony.module.propertyset.PropertyException

removeItem

void removeItem(ConfluenceUser user,
                String key)
         throws com.opensymphony.module.propertyset.PropertyException

Throws:

com.opensymphony.module.propertyset.PropertyException

setBoolean

void setBoolean(ConfluenceUser user,
                String key,
                boolean value)
         throws com.opensymphony.module.propertyset.PropertyException

Throws:

com.opensymphony.module.propertyset.PropertyException

setInt

void setInt(ConfluenceUser user,
            String key,
            int value)
     throws com.opensymphony.module.propertyset.PropertyException

Throws:

com.opensymphony.module.propertyset.PropertyException

setLong

void setLong(ConfluenceUser user,
             String key,
             long value)
      throws com.opensymphony.module.propertyset.PropertyException

Throws:

com.opensymphony.module.propertyset.PropertyException

setDouble

void setDouble(ConfluenceUser user,
               String key,
               double value)
        throws com.opensymphony.module.propertyset.PropertyException

Throws:

com.opensymphony.module.propertyset.PropertyException

setString

void setString(ConfluenceUser user,
               String key,
               @Nullable
               String value)
        throws com.opensymphony.module.propertyset.PropertyException

Throws:

com.opensymphony.module.propertyset.PropertyException

setText

void setText(ConfluenceUser user,
             String key,
             @Nullable
             String value)
      throws com.opensymphony.module.propertyset.PropertyException

Throws:

com.opensymphony.module.propertyset.PropertyException

setDate

void setDate(ConfluenceUser user,
             String key,
             @Nullable
             Date value)
      throws com.opensymphony.module.propertyset.PropertyException

Throws:

com.opensymphony.module.propertyset.PropertyException