org.sonar.api.batch.SonarIndex Maven / Gradle / Ivy
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2014 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* SonarQube is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.batch;
import org.sonar.api.design.Dependency;
import org.sonar.api.measures.Measure;
import org.sonar.api.measures.MeasuresFilter;
import org.sonar.api.resources.Project;
import org.sonar.api.resources.ProjectLink;
import org.sonar.api.resources.Resource;
import org.sonar.api.rules.Violation;
import org.sonar.api.violations.ViolationQuery;
import org.sonar.graph.DirectedGraphAccessor;
import javax.annotation.CheckForNull;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Set;
/**
* @deprecated since 4.5.2 should not be used by plugins.
*/
@Deprecated
public abstract class SonarIndex implements DirectedGraphAccessor {
/**
* Indexes a resource as a direct child of project. This method does nothing and returns true if the resource already indexed.
* If the method resource.getParent() does not return null, then this parent will be indexed too.
*
* @return false if the resource is excluded
* @since 2.6
*/
public abstract boolean index(Resource resource);
/**
* Indexes a resource. This method does nothing if the resource is already indexed.
*
* @param resource the resource to index. Not nullable
* @param parentReference a reference to the indexed parent. If null, the resource is indexed as a direct child of project.
* @return false if the parent is not indexed or if the resource is excluded
* @since 2.6
*/
public abstract boolean index(Resource resource, Resource parentReference);
/**
* Returns true if the referenced resource is excluded. An excluded resource is not indexed.
* @since 2.6
*/
public abstract boolean isExcluded(Resource reference);
/**
* @since 2.6
*/
public abstract boolean isIndexed(Resource reference, boolean acceptExcluded);
/**
* Search for an indexed resource.
*
* @param reference the resource reference
* @return the indexed resource, null if it's not indexed
* @since 1.10. Generic types since 2.6.
*/
public abstract R getResource(R reference);
/**
* @since 2.6
*/
public abstract Resource getParent(Resource reference);
/**
* @since 2.6
*/
public abstract Collection getChildren(Resource reference);
/**
* Save the source code of a file. The file must be have been indexed before.
* Note: the source stream is not closed.
*
* @throws org.sonar.api.resources.DuplicatedSourceException
* if the source has already been set on this resource
* @deprecated since 4.2 should not be used by plugins
*/
@Deprecated
public abstract void setSource(Resource reference, String source);
/**
* @return source code associated with a specified resource, null if not available
* (for example when sonar.importSources=false)
* @since 2.9
*/
@CheckForNull
public abstract String getSource(Resource resource);
public abstract Project getProject();
public final Collection getResources() {
return getVertices();
}
/**
* Indexes the resource.
* @return the indexed resource, even if it's excluded
* @deprecated since 2.6. Use methods index()
*/
@Deprecated
public abstract Resource addResource(Resource resource);
@CheckForNull
public abstract Measure getMeasure(Resource resource, org.sonar.api.batch.measure.Metric metric);
@CheckForNull
public abstract M getMeasures(Resource resource, MeasuresFilter filter);
/**
* Returns the violations that match the {@link ViolationQuery} parameters.
*
* @since 2.8
* @param violationQuery
* the request parameters specified as a {@link ViolationQuery}
* @return the list of violations that match those parameters
* @deprecated in 3.6
*/
@Deprecated
public abstract List getViolations(ViolationQuery violationQuery);
/**
* Returns all the active (= non switched-off) violations found on the given resource. Equivalent to
* {@link #getViolations(ViolationQuery)} called with ViolationQuery.create().forResource(resource).ignoreSwitchedOff(true)
* as a parameter.
*
* @since 2.7
* @return the list of violations
* @deprecated in 3.6
*/
@Deprecated
public final List getViolations(Resource resource) {
return getViolations(ViolationQuery.create().forResource(resource));
}
/**
* @since 2.5
* @deprecated in 3.6
*/
@Deprecated
public abstract void addViolation(Violation violation, boolean force);
/**
* @deprecated in 3.6
*/
@Deprecated
public final void addViolation(Violation violation) {
addViolation(violation, false);
}
/**
* Warning: the resource is automatically indexed for backward-compatibility, but it should be explictly
* indexed before. Next versions will deactivate this automatic indexation.
*/
public abstract Measure addMeasure(Resource resource, Measure measure);
public abstract Dependency addDependency(Dependency dependency);
public abstract Set getDependencies();
public abstract void addLink(ProjectLink link);
public abstract void deleteLink(String key);
public abstract List getEvents(Resource resource);
public abstract void deleteEvent(Event event);
public abstract Event addEvent(Resource resource, String name, String description, String category, Date date);
public final Collection getOutgoingDependencies(Resource from) {
return getOutgoingEdges(from);
}
public final Collection getIncomingDependencies(Resource to) {
return getIncomingEdges(to);
}
}