1 /*
2 * Copyright 2009 Red Hat, Inc.
3 *
4 * Red Hat licenses this file to you under the Apache License, version 2.0
5 * (the "License"); you may not use this file except in compliance with the
6 * License. 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, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package org.jboss.netty.util;
17
18
19 /**
20 * Estimates the size of an object in bytes.
21 *
22 * @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
23 * @author <a href="http://gleamynode.net/">Trustin Lee</a>
24 *
25 * @version $Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $
26 *
27 * @apiviz.landmark
28 * @apiviz.uses org.jboss.netty.util.EstimatableObjectWrapper
29 */
30 public interface ObjectSizeEstimator {
31
32 /**
33 * Returns the estimated size of the specified object in bytes.
34 *
35 * @return a positive integer which represents the size of the specified
36 * object in bytes
37 */
38 int estimateSize(Object o);
39 }