io.virtdata.processors.DocFuncData Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of virtdata-lib-realer Show documentation

With inspiration from other libraries

There is a newer version: 2.12.15

package io.virtdata.processors;

import io.virtdata.annotations.Category;

import java.util.List;

/**
 * Provide data about a function, suitable for building a documentation site.
 */
public interface DocFuncData {

    /**
     * @return the package name for the documented type
     */
    String getPackageName();

    /**
     * @return Return the categories for this function.
     */
    Category[] getCategories();

    /**
     * @return the the {@link Class#getSimpleName()} of the class element
     */
    String getClassName();

    /**
     * Javadoc for the class, or null if there is none.
     * @return a String of class javadoc data, or null if none
     */
    String getClassJavadoc();

    /**
     * The input type for the apply method in the documented function class.
     * Documented function classes must always implement a Java 8 functional interface.
     * @return the input type name
     */
    String getInType();

    /**
     * The output type for the apply method in the documented function class.
     * Documented function classes must always implement a Java 8 functional interface.
     * @return the output type name
     */
    String getOutType();

    /**
     * The list of constructors for this documented type.
     * @return a list of constructor models
     */
    List getCtors();
}