org.jahia.services.cache

Class GroupCacheKey

java.lang.Object

org.jahia.services.cache.GroupCacheKey

All Implemented Interfaces:

Serializable, Comparable<GroupCacheKey>

public class GroupCacheKey
extends Object
implements Serializable, Comparable<GroupCacheKey>

Composite cache key, used when we want to create a key that can be flushed using groups. User: Serge Huber Date: Jul 14, 2005 Time: 2:35:29 PM Copyright (C) Jahia Inc.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GroupCacheKey(Object key, Set<String> groups)
GroupCacheKey(Set<String> groups) This contructor will generate a key based on the combination of the group names.

Method Summary

Modifier and Type	Method and Description
int	compareTo(GroupCacheKey otherKey)
boolean	containsGroup(Object group)
boolean	equals(Object o)
String[]	getGroupArray()
Set<String>	getGroups()
static String	getGroupSeparator()
Object	getKey()
static String	getKeyGroupSeparator()
int	hashCode()
static void	setGroupSeparator(String groupSeparator)
static void	setKeyGroupSeparator(String keyGroupSeparator)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GroupCacheKey

public GroupCacheKey(Set<String> groups)

This contructor will generate a key based on the combination of the group names. In order to avoid name conflict between key and groups names, it is however HIGHLY recommended that you use one of the constructors that seperatly specify the key and group names.

Parameters:

groups -

GroupCacheKey

public GroupCacheKey(Object key,
                     Set<String> groups)

Method Detail

getGroups

public Set<String> getGroups()

getGroupArray

public String[] getGroupArray()

containsGroup

public boolean containsGroup(Object group)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(GroupCacheKey otherKey)

Specified by:

compareTo in interface Comparable<GroupCacheKey>

getKeyGroupSeparator

public static String getKeyGroupSeparator()

setKeyGroupSeparator

public static void setKeyGroupSeparator(String keyGroupSeparator)

getGroupSeparator

public static String getGroupSeparator()

setGroupSeparator

public static void setGroupSeparator(String groupSeparator)

getKey

public Object getKey()