java.lang.Object
- org.infinispan.configuration.cache.GroupsConfigurationBuilder

All Implemented Interfaces:

BaseConfigurationInfo, Builder<GroupsConfiguration>, ConfigurationBuilderInfo, ClusteringConfigurationChildBuilder, ConfigurationChildBuilder
```
public class GroupsConfigurationBuilder
extends Object
implements Builder<GroupsConfiguration>, ConfigurationBuilderInfo
```
Configuration for various grouper definitions. See the user guide for more information.

Author:

pmuir

Field Summary

Fields
Modifier and Type Field Description

protected ConfigurationBuilder builder

Constructor Summary

Constructors
Modifier Constructor Description

protected GroupsConfigurationBuilder(ClusteringConfigurationBuilder builder)

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`GroupsConfigurationBuilder`	`addGrouper(Grouper<?> grouper)`	Add a grouper
`org.infinispan.commons.configuration.attributes.AttributeSet`	`attributes()`
`Configuration`	`build()`
`GroupsConfigurationBuilder`	`clearGroupers()`	Clear the groupers
`ClusteringConfigurationBuilder`	`clustering()`
`GroupsConfiguration`	`create()`	Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()`	Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
`GroupsConfigurationBuilder`	`disabled()`	Disable grouping support so that `Group` annotations are not used and any configured groupers will not be be invoked
`GroupsConfigurationBuilder`	`enabled()`	Enable grouping support so that `Group` annotations are honored and any configured groupers will be invoked
`GroupsConfigurationBuilder`	`enabled(boolean enabled)`	Enable grouping support so that `Group` annotations are honored and any configured groupers will be invoked
`EncodingConfigurationBuilder`	`encoding()`
`ExpirationConfigurationBuilder`	`expiration()`
`protected ConfigurationBuilder`	`getBuilder()`
`protected ClusteringConfigurationBuilder`	`getClusteringBuilder()`
`org.infinispan.commons.configuration.elements.ElementDefinition`	`getElementDefinition()`
`HashConfigurationBuilder`	`hash()`	Allows fine-tuning of rehashing characteristics.
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`boolean`	`isEnabled()`
`L1ConfigurationBuilder`	`l1()`	Configures the L1 cache behavior in 'distributed' caches instances.
`LockingConfigurationBuilder`	`locking()`
`MemoryConfigurationBuilder`	`memory()`
`PartitionHandlingConfigurationBuilder`	`partitionHandling()`	Configures how the cache will react to cluster partitions.
`PersistenceConfigurationBuilder`	`persistence()`
`GroupsConfigurationBuilder`	`read(GroupsConfiguration template)`	Reads the configuration from an already created configuration bean into this builder.
`SecurityConfigurationBuilder`	`security()`
`boolean`	`simpleCache()`
`ConfigurationChildBuilder`	`simpleCache(boolean simpleCache)`
`SitesConfigurationBuilder`	`sites()`
`StateTransferConfigurationBuilder`	`stateTransfer()`	Configures how state is transferred when a new cache joins the cluster.
`StatisticsConfigurationBuilder`	`statistics()`
`ConfigurationChildBuilder`	`template(boolean template)`
`String`	`toString()`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`void`	`validate()`	Validate the data in this builder before building the configuration bean
`void`	`validate(GlobalConfiguration globalConfig)`
`GroupsConfigurationBuilder`	`withGroupers(List<Grouper<?>> groupers)`	Set the groupers to use

Methods inherited from interface org.infinispan.commons.configuration.ConfigurationBuilderInfo
getBuilderInfo, getChildrenInfo, getNewBuilderInfo

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder
build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, persistence, security, simpleCache, simpleCache, sites, statistics, template, transaction, unsafe

- Field Detail
  - builder
```
protected final ConfigurationBuilder builder
```
- Constructor Detail
  - GroupsConfigurationBuilder
```
protected GroupsConfigurationBuilder(ClusteringConfigurationBuilder builder)
```
- Method Detail
  - isEnabled
```
public boolean isEnabled()
```
  - getElementDefinition
```
public org.infinispan.commons.configuration.elements.ElementDefinition getElementDefinition()
```
    Specified by:
    
    getElementDefinition in interface BaseConfigurationInfo
    
    Returns:
    
    the ElementDefinition of the configuration.
  - enabled
```
public GroupsConfigurationBuilder enabled()
```
    Enable grouping support so that Group annotations are honored and any configured groupers will be invoked
  - enabled
```
public GroupsConfigurationBuilder enabled(boolean enabled)
```
    Enable grouping support so that Group annotations are honored and any configured groupers will be invoked
  - disabled
```
public GroupsConfigurationBuilder disabled()
```
    Disable grouping support so that Group annotations are not used and any configured groupers will not be be invoked
  - withGroupers
```
public GroupsConfigurationBuilder withGroupers(List<Grouper<?>> groupers)
```
    Set the groupers to use
  - clearGroupers
```
public GroupsConfigurationBuilder clearGroupers()
```
    Clear the groupers
  - addGrouper
```
public GroupsConfigurationBuilder addGrouper(Grouper<?> grouper)
```
    Add a grouper
  - validate
```
public void validate()
```
    Description copied from interface: Builder
    
    Validate the data in this builder before building the configuration bean
    
    Specified by:
    
    validate in interface Builder<GroupsConfiguration>
  - validate
```
public void validate(GlobalConfiguration globalConfig)
```
    Specified by:
    
    validate in interface ConfigurationChildBuilder
  - create
```
public GroupsConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<GroupsConfiguration>
    
    Returns:
  - read
```
public GroupsConfigurationBuilder read(GroupsConfiguration template)
```
    Description copied from interface: Builder
    
    Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration
    
    Specified by:
    
    read in interface Builder<GroupsConfiguration>
    
    Parameters:
    
    template - the configuration from which to "clone" this config if needed.
  - toString
```
public String toString()
```
  - attributes
```
public org.infinispan.commons.configuration.attributes.AttributeSet attributes()
```
    Specified by:
    
    attributes in interface BaseConfigurationInfo
    
    Returns:
    
    the AttributeSet declared by the configuration.
  - hash
```
public HashConfigurationBuilder hash()
```
    Description copied from interface: ClusteringConfigurationChildBuilder
    
    Allows fine-tuning of rehashing characteristics. Must only used with 'distributed' cache mode.
    
    Specified by:
    
    hash in interface ClusteringConfigurationChildBuilder
  - l1
```
public L1ConfigurationBuilder l1()
```
    Description copied from interface: ClusteringConfigurationChildBuilder
    
    Configures the L1 cache behavior in 'distributed' caches instances. In any other cache modes, this element is ignored.
    
    Specified by:
    
    l1 in interface ClusteringConfigurationChildBuilder
  - stateTransfer
```
public StateTransferConfigurationBuilder stateTransfer()
```
    Description copied from interface: ClusteringConfigurationChildBuilder
    
    Configures how state is transferred when a new cache joins the cluster. Used with distribution and replication clustered modes.
    
    Specified by:
    
    stateTransfer in interface ClusteringConfigurationChildBuilder
  - partitionHandling
```
public PartitionHandlingConfigurationBuilder partitionHandling()
```
    Description copied from interface: ClusteringConfigurationChildBuilder
    
    Configures how the cache will react to cluster partitions.
    
    Specified by:
    
    partitionHandling in interface ClusteringConfigurationChildBuilder
  - getClusteringBuilder
```
protected ClusteringConfigurationBuilder getClusteringBuilder()
```
  - template
```
public ConfigurationChildBuilder template(boolean template)
```
    Specified by:
    
    template in interface ConfigurationChildBuilder
  - simpleCache
```
public ConfigurationChildBuilder simpleCache(boolean simpleCache)
```
    Specified by:
    
    simpleCache in interface ConfigurationChildBuilder
  - simpleCache
```
public boolean simpleCache()
```
    Specified by:
    
    simpleCache in interface ConfigurationChildBuilder
  - clustering
```
public ClusteringConfigurationBuilder clustering()
```
    Specified by:
    
    clustering in interface ConfigurationChildBuilder
  - customInterceptors
```
@Deprecated
public CustomInterceptorsConfigurationBuilder customInterceptors()
```
    Deprecated.
    Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
    
    Specified by:
    
    customInterceptors in interface ConfigurationChildBuilder
  - encoding
```
public EncodingConfigurationBuilder encoding()
```
    Specified by:
    
    encoding in interface ConfigurationChildBuilder
  - expiration
```
public ExpirationConfigurationBuilder expiration()
```
    Specified by:
    
    expiration in interface ConfigurationChildBuilder
  - indexing
```
public IndexingConfigurationBuilder indexing()
```
    Specified by:
    
    indexing in interface ConfigurationChildBuilder
  - invocationBatching
```
public InvocationBatchingConfigurationBuilder invocationBatching()
```
    Specified by:
    
    invocationBatching in interface ConfigurationChildBuilder
  - statistics
```
public StatisticsConfigurationBuilder statistics()
```
    Specified by:
    
    statistics in interface ConfigurationChildBuilder
  - persistence
```
public PersistenceConfigurationBuilder persistence()
```
    Specified by:
    
    persistence in interface ConfigurationChildBuilder
  - locking
```
public LockingConfigurationBuilder locking()
```
    Specified by:
    
    locking in interface ConfigurationChildBuilder
  - security
```
public SecurityConfigurationBuilder security()
```
    Specified by:
    
    security in interface ConfigurationChildBuilder
  - transaction
```
public TransactionConfigurationBuilder transaction()
```
    Specified by:
    
    transaction in interface ConfigurationChildBuilder
  - unsafe
```
public UnsafeConfigurationBuilder unsafe()
```
    Specified by:
    
    unsafe in interface ConfigurationChildBuilder
  - sites
```
public SitesConfigurationBuilder sites()
```
    Specified by:
    
    sites in interface ConfigurationChildBuilder
  - memory
```
public MemoryConfigurationBuilder memory()
```
    Specified by:
    
    memory in interface ConfigurationChildBuilder
  - getBuilder
```
protected ConfigurationBuilder getBuilder()
```
  - build
```
public Configuration build()
```
    Specified by:
    
    build in interface ConfigurationChildBuilder

Class GroupsConfigurationBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from interface org.infinispan.commons.configuration.ConfigurationBuilderInfo

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

Field Detail

builder

Constructor Detail

GroupsConfigurationBuilder

Method Detail

isEnabled

getElementDefinition

enabled

enabled

disabled

withGroupers

clearGroupers

addGrouper

validate

validate

create

read

toString

attributes

hash

l1

stateTransfer

partitionHandling

getClusteringBuilder

template

simpleCache

simpleCache

clustering

customInterceptors

encoding

expiration

indexing

invocationBatching

statistics

persistence

locking

security

transaction

unsafe

sites

memory

getBuilder

build