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.regionserver;
019
020import java.util.Collection;
021import org.apache.hadoop.conf.Configured;
022import org.apache.yetus.audience.InterfaceAudience;
023
024/**
025 * A flush policy determines the stores that need to be flushed when flushing a region.
026 */
027@InterfaceAudience.Private
028public abstract class FlushPolicy extends Configured {
029
030  /**
031   * The region configured for this flush policy.
032   */
033  protected HRegion region;
034
035  /**
036   * Upon construction, this method will be called with the region to be governed. It will be called
037   * once and only once.
038   */
039  protected void configureForRegion(HRegion region) {
040    this.region = region;
041  }
042
043  /** Returns the stores need to be flushed. */
044  public abstract Collection<HStore> selectStoresToFlush();
045}