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 * Represents an object which contains another object that needs to be taken
20 * into account by {@link ObjectSizeEstimator} for more accurate object size
21 * estimation.
22 *
23 * @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
24 * @author <a href="http://gleamynode.net/">Trustin Lee</a>
25 * @version $Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $
26 */
27 public interface EstimatableObjectWrapper {
28
29 /**
30 * Returns the underlying object that needs to be taken into account
31 * by {@link ObjectSizeEstimator} for more accurate object size estimation.
32 */
33 Object unwrap();
34 }