001/*
002 * Sonar, open source software quality management tool.
003 * Copyright (C) 2008-2012 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * Sonar is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * Sonar is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public
017 * License along with Sonar; if not, write to the Free Software
018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019 */
020package org.sonar.plugins.dbcleaner.api;
021
022import org.sonar.api.BatchExtension;
023import org.sonar.api.database.DatabaseSession;
024
025/**
026 * Implement this component in order to define your own rules to cleanup database.
027 *
028 * @since 2.5
029 * @deprecated in 2.14
030 */
031@Deprecated
032public abstract class Purge implements BatchExtension {
033
034  private DatabaseSession session;
035
036  protected Purge(DatabaseSession session) {
037    this.session = session;
038  }
039
040  protected final DatabaseSession getSession() {
041    return session;
042  }
043
044  /**
045   * Snapshots include the current snapshot (flagged as last) and optionally the penultimate one.
046   *
047   * @snapshots never null.
048   */
049  public abstract void purge(PurgeContext context);
050
051  @Override
052  public String toString() {
053    return getClass().getName();
054  }
055}