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 */
020package org.sonar.batch.protocol.output;
021
022import java.io.File;
023
024/**
025 * Structure of files in the zipped report
026 */
027public class FileStructure {
028
029  public static enum Domain {
030    ISSUES("issues-"), ISSUES_ON_DELETED("issues-deleted-"), COMPONENT("component-");
031
032    private final String filePrefix;
033
034    Domain(String filePrefix) {
035      this.filePrefix = filePrefix;
036    }
037  }
038
039  private final File dir;
040
041  FileStructure(File dir) {
042    if (!dir.exists() || !dir.isDirectory()) {
043      throw new IllegalArgumentException("Directory of analysis report does not exist: " + dir);
044    }
045    this.dir = dir;
046  }
047
048  public File metadataFile() {
049    return new File(dir, "metadata.pb");
050  }
051
052  public File fileFor(Domain domain, int componentRef) {
053    return new File(dir, domain.filePrefix + componentRef + ".pb");
054  }
055
056}