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.pmd;
020
021import org.jdrupes.builder.api.Project;
022import org.jdrupes.builder.api.Resource;
023import org.jdrupes.builder.api.ResourceFactory;
024import org.jdrupes.builder.api.ResourceProvider;
025
026/// Provides the results from running PMD.
027///
028public interface PmdResult extends Resource {
029
030    /// The project that was checked.
031    ///
032    /// @return the project
033    ///
034    Project project();
035
036    /// Returns the number of checked files.
037    ///
038    /// @return the number
039    ///
040    long checked();
041
042    /// Returns the number of rule violations.
043    ///
044    /// @return the number
045    ///
046    long violations();
047
048    /// Creates a new PMD result from the given values.
049    ///
050    /// @param project the project
051    /// @param provider the provider
052    /// @param checked the number of checked files
053    /// @param violations the number of rule violations
054    /// @return the PMD result
055    ///
056    @SuppressWarnings("PMD.ShortMethodName")
057    static PmdResult of(Project project, ResourceProvider provider,
058            long checked, long violations) {
059        return ResourceFactory.create(PmdTypes.PmdResultType,
060            project, provider, checked, violations);
061    }
062}