Package org.opencms.flex

Class CmsFlexBucketConfiguration.BucketSet

java.lang.Object

org.opencms.flex.CmsFlexBucketConfiguration.BucketSet

Enclosing class:

CmsFlexBucketConfiguration

public class CmsFlexBucketConfiguration.BucketSet
extends Object

A data structure representing a set of Flex cache buckets.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BucketSet(Set<String> buckets)	Creates a new instance from a set of bucket names.

Method Summary

Modifier and Type	Method	Description
List<String>	getBucketNames()	Computes the list of bucket names for this instance.
boolean	matchForDeletion(CmsFlexBucketConfiguration.BucketSet flexEntryBucketSet)	If this entry is the bucket set created from a publish list, and the argument is the bucket list of a flex cache entry, then the result of this method determines whether the flex cache entry for which the argument bucket set was created should be removed.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

BucketSet

protected BucketSet(Set<String> buckets)

Creates a new instance from a set of bucket names.

Parameters:

buckets - the bucket names

Method Details

getBucketNames

public List<String> getBucketNames()

Computes the list of bucket names for this instance.

Returns:

the list of bucket names

matchForDeletion

public boolean matchForDeletion(CmsFlexBucketConfiguration.BucketSet flexEntryBucketSet)

If this entry is the bucket set created from a publish list, and the argument is the bucket list of a flex cache entry, then the result of this method determines whether the flex cache entry for which the argument bucket set was created should be removed.

Parameters:

flexEntryBucketSet - the bucket set for the flex cache entry

Returns:

true if the flex cache entry from which argument flex bucket set was generated should be removed.

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()