001/*
002 * JDrupes Builder
003 * Copyright (C) 2026 Michael N. Lipp
004 * 
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
017 */
018
019package org.jdrupes.builder.ext.checkstyle;
020
021import org.jdrupes.builder.api.FaultAware;
022import org.jdrupes.builder.api.Project;
023import org.jdrupes.builder.api.Resource;
024import org.jdrupes.builder.api.ResourceFactory;
025import org.jdrupes.builder.api.ResourceProvider;
026
027/// Provides the results from running checkstyle.
028///
029public interface CheckstyleResult extends Resource, FaultAware {
030
031    /// The project that was checked.
032    ///
033    /// @return the project
034    ///
035    Project project();
036
037    /// Returns the number of checked files.
038    ///
039    /// @return the number
040    ///
041    long checked();
042
043    /// Returns the number of style violations with error severity.
044    ///
045    /// @return the number
046    ///
047    long errors();
048
049    /// Returns the number of style violations with warning severity.
050    ///
051    /// @return the number
052    ///
053    long warnings();
054
055    /// Creates a new checkstyle result from the given values.
056    ///
057    /// @param project the project
058    /// @param provider the provider
059    /// @param checked the number of checked files
060    /// @param errors the number of style violations with error severity
061    /// @param warnings the number of style violations with warning severity
062    /// @return the checkstyle result
063    ///
064    @SuppressWarnings("PMD.ShortMethodName")
065    static CheckstyleResult of(Project project, ResourceProvider provider,
066            long checked, long errors, long warnings) {
067        return ResourceFactory.create(CheckstyleTypes.CheckstyleResultType,
068            project, provider, checked, errors, warnings);
069    }
070}