com.ly.doc.model.RpcJavaMethod Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smart-doc Show documentation
Smart-doc is a tool that supports both JAVA RESTFUL API and Apache Dubbo RPC interface document generation.
There is a newer version: 3.0.5
/*
 * Copyright (C) 2018-2023 smart-doc
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */
package com.ly.doc.model;

import com.ly.doc.utils.ParamUtil;
import com.thoughtworks.qdox.model.JavaClass;
import com.thoughtworks.qdox.model.JavaMethod;
import com.thoughtworks.qdox.model.JavaType;

import java.util.List;
import java.util.Map;

/**
 * for rpc
 * @author yu 2020/1/29.
 */
public class RpcJavaMethod implements IMethod {

    /**
     * java method
     */
    private JavaMethod javaMethod;

    /**
     * methodId handled by md5
     */
    private String methodId;

    /**
     * method name
     */
    private String name;

    /**
     * method order
     */
    private int order;


    /**
     * method description
     */
    private String desc;

    /**
     * method definition
     */
    private String methodDefinition;

    /**
     * escape method definition
     */
    private String escapeMethodDefinition;

    /**
     * detailed introduction of the method
     */
    private String detail;

    /**
     * method describe
     */
    private String throwsInfo;

    /**
     * return class Info
     */
    private String returnClassInfo;

    /**
     * http request params
     */
    private List requestParams;

    /**
     * http request author
     */
    private String author;

    /**
     * http response params
     */
    private List responseParams;

    /**
     * method deprecated
     */
    private boolean deprecated;

    private Map actualTypesMap;


    private String version;

    public String getVersion() {
        return version;
    }

    public RpcJavaMethod setVersion(String version) {
        this.version = version;
        return this;
    }

    public static RpcJavaMethod builder() {
        return new RpcJavaMethod();
    }

    public JavaMethod getJavaMethod() {
        return javaMethod;
    }

    public RpcJavaMethod setJavaMethod(JavaMethod javaMethod) {
        this.javaMethod = javaMethod;
        return this;
    }

    public String getMethodId() {
        return methodId;
    }

    public RpcJavaMethod setMethodId(String methodId) {
        this.methodId = methodId;
        return this;
    }

    public String getName() {
        return name;
    }

    public RpcJavaMethod setName(String name) {
        this.name = name;
        return this;
    }

    public int getOrder() {
        return order;
    }

    public RpcJavaMethod setOrder(int order) {
        this.order = order;
        return this;
    }

    public String getDesc() {
        return desc;
    }

    public RpcJavaMethod setDesc(String desc) {
        this.desc = desc;
        return this;
    }

    public String getDetail() {
        return detail;
    }

    public RpcJavaMethod setDetail(String detail) {
        this.detail = detail;
        return this;
    }

    public String getThrowsInfo() {
        return throwsInfo;
    }

    public RpcJavaMethod setThrowsInfo(String throwsInfo) {
        this.throwsInfo = throwsInfo;
        return this;
    }

    public String getReturnClassInfo() {
        return returnClassInfo;
    }

    public RpcJavaMethod setReturnClassInfo(String returnClassInfo) {
        this.returnClassInfo = returnClassInfo;
        return this;
    }

    public String getAuthor() {
        return author;
    }

    public RpcJavaMethod setAuthor(String author) {
        this.author = author;
        return this;
    }

    public List getResponseParams() {
        return responseParams;
    }

    public RpcJavaMethod setResponseParams(List responseParams) {
        this.responseParams = responseParams;
        return this;
    }

    public boolean isDeprecated() {
        return deprecated;
    }

    public RpcJavaMethod setDeprecated(boolean deprecated) {
        this.deprecated = deprecated;
        return this;
    }

    public List getRequestParams() {
        return requestParams;
    }

    public RpcJavaMethod setRequestParams(List requestParams) {
        this.requestParams = requestParams;
        return this;
    }

    public String getMethodDefinition() {
        return methodDefinition;
    }

    public RpcJavaMethod setMethodDefinition(String methodDefinition) {
        this.methodDefinition = methodDefinition;
        return this;
    }

    public String getEscapeMethodDefinition() {
        return escapeMethodDefinition;
    }

    public RpcJavaMethod setEscapeMethodDefinition(String escapeMethodDefinition) {
        this.escapeMethodDefinition = escapeMethodDefinition;
        return this;
    }

    public Map getActualTypesMap() {
        return actualTypesMap;
    }

    public RpcJavaMethod setActualTypesMap(Map actualTypesMap) {
        this.actualTypesMap = actualTypesMap;
        return this;
    }

    @Override
    public JavaClass getDeclaringClass() {
        return this.javaMethod.getDeclaringClass();
    }

    @Override
    public String getMethodName() {
        return this.name;
    }

    @Override
    public List getArgsClasses() {
        return ParamUtil.extractQualifiedName(this.requestParams);
    }

    @Override
    public List getReturnClasses() {
        return ParamUtil.extractQualifiedName(this.responseParams);
    }
}