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  /**
20   * Estimates the size of an object in bytes.
21   *
22   * @apiviz.landmark
23   * @apiviz.uses org.jboss.netty.util.EstimatableObjectWrapper
24   */
25  public interface ObjectSizeEstimator {
26  
27      /**
28       * Returns the estimated size of the specified object in bytes.
29       *
30       * @return a positive integer which represents the size of the specified
31       *         object in bytes
32       */
33      int estimateSize(Object o);
34  }