fluent.api.generator.model.MethodModel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fluent-api-generator Show documentation
There is a newer version: 2.18
/*
 * BSD 2-Clause License
 *
 * Copyright (c) 2018, Ondrej Fischer
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 *  Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

package fluent.api.generator.model;

import java.util.List;


/**
 * Model of a method, that will be passed to the template, and can be used to drive generation of
 * derived java classes.
 */
public interface MethodModel extends ElementModel {

    /**
     * Get name of the method (simple string).
     * @return Name of the method.
     */
    String name();

    /**
     * Get property name using standard prefixes - setX/getX/isX.
     * @return Property name.
     */
    String propertyName() ;

    /**
     * Convert method name to property name by replacement using regular expression end replacement group.
     * @param regexPrefix Regular expression to match property name part of the method name.
     * @param group Which group identifies the name.
     * @return Property name.
     */
    String toProperty(String regexPrefix, String group);

    /**
     * Get list of parameter (variable) models.
     * @return List of parameter (variable) models.
     */
    List parameters();

    List typeVariables();

    TypeModel declaringClass();

    boolean isConstructor();

    List parameterTypes();

}