001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube 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     * SonarQube 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 License
017     * along with this program; if not, write to the Free Software Foundation,
018     * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019     */
020    package org.sonar.batch.index;
021    
022    import org.sonar.api.batch.fs.InputFile;
023    import org.sonar.api.database.model.Snapshot;
024    import org.sonar.api.resources.Project;
025    import org.sonar.api.resources.Resource;
026    
027    import javax.annotation.CheckForNull;
028    import javax.annotation.Nullable;
029    
030    public interface ResourcePersister {
031    
032      Snapshot saveProject(Project project, @Nullable Project parent);
033    
034      /**
035       * Persist a resource in database. Returns null if the resource must not be persisted (scope lower than file)
036       */
037      Snapshot saveResource(Project project, Resource resource, @Nullable Resource parent);
038    
039      /**
040       * Persist a resource in database. Returns null if the resource must not be persisted (scope lower than file)
041       */
042      Snapshot saveResource(Project project, Resource resource);
043    
044      @CheckForNull
045      Snapshot getSnapshot(Resource resource);
046    
047      Snapshot getSnapshotOrFail(Resource resource);
048    
049      Snapshot getSnapshotOrFail(InputFile resource);
050    
051      /**
052       * The current snapshot which is flagged as "last", different than the current analysis.
053       * @param onlyOlder true if the result must be anterior to the snapshot parameter
054       */
055      @CheckForNull
056      Snapshot getLastSnapshot(Snapshot snapshot, boolean onlyOlder);
057    
058      void clear();
059    }