1 /***
2 * Copyright 2003-2010 Terracotta, Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package net.sf.ehcache.pool;
18
19 /***
20 * SizeOf engines are used to calculate the size of elements stored in poolable stores.
21 *
22 * @author Ludovic Orban
23 */
24 public interface SizeOfEngine {
25
26 /***
27 * Size an element
28 *
29 * @param key the key of the element
30 * @param value the value of the element
31 * @param container the container of the element, ie: element object + eventual overhead
32 * @return the size of the element in bytes
33 */
34 long sizeOf(Object key, Object value, Object container);
35
36 }