001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2008-2011 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     */
020    package org.sonar.plugins.dbcleaner.api;
021    
022    import org.sonar.api.BatchExtension;
023    import 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     */
030    public abstract class Purge implements BatchExtension {
031    
032      private DatabaseSession session;
033    
034      protected Purge(DatabaseSession session) {
035        this.session = session;
036      }
037    
038      protected final DatabaseSession getSession() {
039        return session;
040      }
041    
042      /**
043       * Snapshots include the current snapshot (flagged as last) and optionally the penultimate one.
044       *
045       * @snapshots never null.
046       */
047      public abstract void purge(PurgeContext context);
048    
049      @Override
050      public String toString() {
051        return getClass().getName();
052      }
053    }