001/*
002 *
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *     http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 */
019
020package org.apache.hadoop.hbase.io;
021
022import org.apache.yetus.audience.InterfaceAudience;
023
024/**
025 * An optional interface to 'size' writables.
026 */
027@InterfaceAudience.Private
028public interface WritableWithSize {
029  /**
030   * Provide a size hint to the caller. write() should ideally
031   * not go beyond this if at all possible.
032   *
033   * You can return 0 if there is no size hint.
034   *
035   * @return the size of the writable
036   */
037  long getWritableSize();
038}