hbase-server/src/main/java/org/apache/hadoop/hbase/io/WritableWithSize.java

/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.hadoop.hbase.io;

import org.apache.yetus.audience.InterfaceAudience;

/**
 * An optional interface to 'size' writables.
 */
@InterfaceAudience.Private
public interface WritableWithSize {
  /**
   * Provide a size hint to the caller. write() should ideally
   * not go beyond this if at all possible.
   *
   * You can return 0 if there is no size hint.
   *
   * @return the size of the writable
   */
  long getWritableSize();
}