Package org.ehcache.spi.service

Interface ServiceConfiguration<T extends Service,R>

Type Parameters:
T - the service type this configuration works with
R - the type of the detached representation
All Known Subinterfaces:
CacheLoaderWriterConfiguration<R>, PersistableResourceService.PersistenceSpaceIdentifier<T>, WriteBehindConfiguration<R>
public interface ServiceConfiguration<T extends Service,R>
A configuration type to be used when interacting with a Service.

  • Method Summary

    Modifier and Type
    Method
    Description
    default ServiceConfiguration<T,?>
    build(R representation)
    Construct a new configuration from the given detached representation.
    default boolean
    compatibleWith(ServiceConfiguration<?,?> other)
    Returns true if this configuration can co-exist with other in the same cache configuration.
    default R
    derive()
    Derive a detached representation from this configuration
    Class<T>
    getServiceType()
    Indicates which service this configuration works with.

  • Method Details

    • getServiceType

      Class<T> getServiceType()
      Indicates which service this configuration works with.
      Returns:
      the service type

    • derive

      default R derive() throws UnsupportedOperationException
      Derive a detached representation from this configuration
      Returns:
      a detached representation
      Throws:
      UnsupportedOperationException - if the configuration has no representation

    • build

      default ServiceConfiguration<T,?> build(R representation) throws UnsupportedOperationException
      Construct a new configuration from the given detached representation.
      Parameters:
      representation - a detached representation
      Returns:
      a new configuration
      Throws:
      UnsupportedOperationException - if the configuration has no representation

    • compatibleWith

      default boolean compatibleWith(ServiceConfiguration<?,?> other)
      Returns true if this configuration can co-exist with other in the same cache configuration.

      The default implementation of compatibleWith (as used by many of the implementations) considers any instance of the same type (or a sub-type) to be incompatible with this instance.

      Parameters:
      other - other service configuration
      Returns:
      true if the two configurations are compatible