1 /* 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, software 14 * distributed under the License is distributed on an "AS IS" BASIS, 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 * See the License for the specific language governing permissions and 17 * limitations under the License. 18 */ 19 20 package org.apache.hadoop.hbase.io; 21 22 import org.apache.hadoop.hbase.classification.InterfaceAudience; 23 24 /** 25 * An optional interface to 'size' writables. 26 */ 27 @InterfaceAudience.Private 28 public interface WritableWithSize { 29 /** 30 * Provide a size hint to the caller. write() should ideally 31 * not go beyond this if at all possible. 32 * 33 * You can return 0 if there is no size hint. 34 * 35 * @return the size of the writable 36 */ 37 long getWritableSize(); 38 }