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