]> source.dussan.org Git - sonarqube.git/blob
f9ae8404effc8260d31e5480dc219609a1da6ac7
[sonarqube.git] /
1 /*
2  * SonarQube
3  * Copyright (C) 2009-2017 SonarSource SA
4  * mailto:info AT sonarsource DOT com
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 3 of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
19  */
20 package org.sonar.server.computation.task.projectanalysis.component;
21
22 /**
23  * The tree of components defined in the scanner report.
24  */
25 public interface TreeRootHolder {
26   /**
27    * The root of the tree, for example the project or the portfolio.
28    * With branches, it will refer to the root component of the branch.
29    *
30    * @throws IllegalStateException if the holder is empty (ie. there is no root yet)
31    */
32   Component getRoot();
33
34   /**
35    * Return a component by its batch reference
36    *
37    * @throws IllegalStateException if the holder is empty (ie. there is no root yet)
38    * @throws IllegalArgumentException if there's no {@link Component} with the specified reference
39    */
40   Component getComponentByRef(int ref);
41
42 }