com.qualinsight.plugins.sonarqube.maven.api.registration.AbstractMavenCheckClassesContainer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of qualinsight-plugins-sonarqube-maven-api Show documentation

API classes of the QualInsight Maven plugin for SonarQube.

The newest version!

/*
 * qualinsight-plugins-sonarqube-maven-api
 * Copyright (c) 2015-2016, QualInsight
 * http://www.qualinsight.com/
 *
 * This program 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.
 *
 * This program 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, you can retrieve a copy
 * from .
 */
/*
 * This file is part of qualinsight-plugins-sonarqube-maven-api.
 *
 * qualinsight-plugins-sonarqube-maven-api 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.
 *
 * qualinsight-plugins-sonarqube-maven-api 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 qualinsight-plugins-sonarqube-maven-api.  If not, see .
 */
package com.qualinsight.plugins.sonarqube.maven.api.registration;

import java.util.List;
import com.google.common.annotations.Beta;
import org.sonar.api.batch.BatchSide;
import org.sonar.api.server.ServerSide;
import com.qualinsight.plugins.sonarqube.maven.api.model.AbstractMavenCheck;

/**
 * Container that helds a {@link List} of custom {@link AbstractMavenCheck} classes that are part of a Rules repository.
 *
 * @author Michel Pawlak
 */
@Beta
@BatchSide
@ServerSide
public abstract class AbstractMavenCheckClassesContainer {

    /**
     * {@link AbstractMavenCheckClassesContainer}'s repository key.
     *
     * @return key of the rules repository to which the custom {@link AbstractMavenCheck} classes must be added.
     */
    public abstract String repositoryKey();

    /**
     * {@link List} of {@link AbstractMavenCheck} classes the {@link AbstractMavenCheckClassesContainer} is holding.
     *
     * @return a {@link List} of custom {@link AbstractMavenCheck} classes.
     */
    public abstract List> classes();

}