net.sf.ehcache.search.attribute.DynamicAttributesExtractor Maven / Gradle / Ivy
/**
* Copyright Terracotta, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.sf.ehcache.search.attribute;
import java.util.Map;
import net.sf.ehcache.Element;
/**
* Dynamic indexing API
* @author vfunshte
*/
public interface DynamicAttributesExtractor {
/**
* Given a particular cache element, returns a map from attribute names, to their respective values to use for indexing.
* This method will be called once for every {@link Ehcache#put(Element)} and {@link Ehcache#replace(Element)} call.
* @param element
* @return
*/
Map attributesFor(Element element);
}