com.manoelcampos.javadoc.coverage.stats.DocStats Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javadoc-coverage Show documentation

Doclet to generate coverage reports of JavaDoc documentation.

There is a newer version: 1.1.1

/*
 * Copyright 2017-2017 Manoel Campos da Silva Filho
 *
 * Licensed under the General Public License Version 3 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    https://www.gnu.org/licenses/gpl-3.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.
 */
package com.manoelcampos.javadoc.coverage.stats;

import com.manoelcampos.javadoc.coverage.Utils;

/**
 * An interface to be implemented by classes
 * computing JavaDoc coverage statistics.
 *
 * @author Manoel Campos da Silva Filho
 * @since 1.0.0
 */
public interface DocStats {
    /**
     * The type of the element to which JavaDoc coverage statistics is being computed,
     * whether a class, interface, field, method, parameter, etc.
     * @return the type of elements
     */
    String getType();

    /**
     * Gets the number of documented members contained into
     * the object for which the JavaDoc coverage statistics is being computed.
     *
     * @return the number of members having JavaDoc documentation
     */
    long getDocumentedMembers();

    /**
     * Gets the number of undocumented members contained into
     * the object for which the JavaDoc coverage statistics is being computed.
     *
     * @return the number of members not having JavaDoc documentation
     */
    default long getUndocumentedMembers() {
        return getMembersNumber() - getDocumentedMembers();
    }

    /**
     * Gets the percentage of documented members contained into
     * the object for which the JavaDoc coverage statistics is being computed.
     *
     * @return the percentage of documented members, in scale from 0 to 100.
     */
    default double getDocumentedMembersPercent(){
        return Utils.computePercentage(getDocumentedMembers(), getMembersNumber());
    }

    /**
     * Gets the total number of members contained into
     * the object for which the JavaDoc coverage statistics is being computed.
     *
     * @return the total number of members
     */
    long getMembersNumber();
}