View Javadoc
1   /*
2    * Copyright 2012 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the 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  public interface EstimatableObjectWrapper {
24  
25      /**
26       * Returns the underlying object that needs to be taken into account
27       * by {@link ObjectSizeEstimator} for more accurate object size estimation.
28       */
29      Object unwrap();
30  }