Interface ResourceMappingRegistry

All Superinterfaces:
Iterable<ResourceMapping>
All Known Implementing Classes:
SchemeMappingRegistry

public interface ResourceMappingRegistry extends Iterable<ResourceMapping>
A SchemeMappingRegistry provides a mechanism manage a collection of ResourceMappings, together with the ability to search the registry for said ResourceMappings, possibly using wild-cards.

ResourceMappingRegistrys are Iterable, the order of iteration being that in which the ResourceMappings where added to the said ResourceMappingRegistry.

Since:
Coherence 14.1.1
Author:
jk 2015.06.01
  • Method Details

    • register

      void register(ResourceMapping mapping) throws IllegalArgumentException
      Parameters:
      mapping - the ResourceMapping to register
      Throws:
      IllegalArgumentException - if a ResourceMapping with the same pattern has already been registered
    • findCacheMapping

      default CacheMapping findCacheMapping(String sName)
      Attempts to find the CacheMapping that matches the specified name and type.

      The matching algorithm first attempts to find an exact match of a CacheMapping with the provided name. Should that fail, all of the currently registered wild-carded CacheMappings are searched to find a match (in the order in which they were registered), with the most specific (longest match) being returned if there are multiple matches.

      Parameters:
      sName - the name
      Returns:
      null if a mapping could not be located for the specified name and type
    • findMapping

      <M extends ResourceMapping> M findMapping(String sName, Class<M> type)
      Attempts to find the ResourceMapping that matches the specified name and type.

      The matching algorithm first attempts to find an exact match of a ResourceMapping with the provided name. Should that fail, all of the currently registered wild-carded ResourceMappings are searched to find a match (in the order in which they were registered), with the most specific (longest match) being returned if there are multiple matches.

      Parameters:
      sName - the name
      type - the type of the mapping to locate
      Returns:
      null if a mapping could not be located for the specified name and type
    • size

      int size()
      Determines the number of ResourceMappings in this ResourceMappingRegistry.
      Returns:
      the number of ResourceMappings