IMetricsService.java

package org.jtheque.metrics.services.able;

/*
 * Copyright JTheque (Baptiste Wicht)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import org.jtheque.metrics.utils.elements.Project;
import org.jtheque.metrics.utils.projects.ModularProject;

import java.util.Collection;

/**
 * A metrics service specification.
 *
 * @author Baptiste Wicht
 */
public interface IMetricsService {
    /**
     * Generate the metrics for a modular project.
     *
     * @param project The modular projects to generate the metrics for.
     *
     * @return A List containing all the metrics projects of the results.
     */
    Collection<Project> generateMetrics(ModularProject project);
}