001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.quotas;
019
020import org.apache.hadoop.hbase.io.HeapSize;
021import org.apache.yetus.audience.InterfaceAudience;
022
023/**
024 * Interface that encapsulates optionally sending a Region's size to the master.
025 */
026@InterfaceAudience.Private
027public interface RegionSize extends HeapSize {
028
029  /**
030   * Updates the size of the Region.
031   * @param newSize the new size of the Region
032   * @return {@code this}
033   */
034  RegionSize setSize(long newSize);
035
036  /**
037   * Atomically adds the provided {@code delta} to the region size.
038   * @param delta The change in size in bytes of the region.
039   * @return {@code this}
040   */
041  RegionSize incrementSize(long delta);
042
043  /**
044   * Returns the size of the region.
045   * @return The size in bytes.
046   */
047  long getSize();
048}