com.power.doc.utils

类 DocUtil

java.lang.Object

com.power.doc.utils.DocUtil

public class DocUtil
extends Object

Description: DocUtil

作者:

yu 2018/06/11.

构造器概要

构造器

构造器和说明
DocUtil()

方法概要

限定符和类型	方法和说明
static String	formatAndRemove(String str, Map<String,String> values) An interpreter for strings with named placeholders.
static Map<String,String>	formDataToMap(List<FormData> formDataList)
static String	generateId(String value) Use md5 generate id number
static String	getEscapeAndCleanComment(String comment) Gets escape and clean comment.
static Map<String,String>	getFieldTagsValue(com.thoughtworks.qdox.model.JavaField field, DocJavaField docJavaField) Get field tags
static String	getFirstKeyAndValue(Map<String,String> map) Get the first element of a map.
static String	getNormalTagComments(com.thoughtworks.qdox.model.JavaMethod javaMethod, String tagName, String className) obtain java doc tags comments,like apiNote
static Map<String,String>	getParamsComments(com.thoughtworks.qdox.model.JavaMethod javaMethod, String tagName, String className) obtain params comments
static String	getRequestMappingUrl(com.thoughtworks.qdox.model.JavaAnnotation annotation) Get the url from 'value' or 'path' attribute
static String	getValByTypeAndFieldName(String typeName, String filedName) Generate random field values based on field field names and type.
static String	getValByTypeAndFieldName(String type0, String filedName, boolean removeDoubleQuotation) 移除字符串的双引号
static String	handleHttpMethod(String method) handle spring mvc method
static String	handleJsonStr(String content)
static String	handleMappingValue(com.thoughtworks.qdox.model.JavaAnnotation annotation) handle spring mvc mapping value
static boolean	isClassName(String className) 是否是合法的java类名称
static boolean	isMatch(String packageFilters, String controllerName) match controller package
static boolean	javaPrimaryType(String type)
static String	javaTypeToOpenApiTypeConvert(String type)
static String	jsonValueByType(String typeName) Generate a random value based on java type name.
static String	replaceNewLineToHtmlBr(String content)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

DocUtil

public DocUtil()

方法详细资料

jsonValueByType

public static String jsonValueByType(String typeName)

Generate a random value based on java type name.

参数:

typeName - field type name

返回:

random value

getValByTypeAndFieldName

public static String getValByTypeAndFieldName(String typeName,
                                              String filedName)

Generate random field values based on field field names and type.

参数:

typeName - field type name

filedName - field name

返回:

random value

getValByTypeAndFieldName

public static String getValByTypeAndFieldName(String type0,
                                              String filedName,
                                              boolean removeDoubleQuotation)

移除字符串的双引号

参数:

type0 - 类型

filedName - 字段名称

removeDoubleQuotation - 移除标志

返回:

String

isClassName

public static boolean isClassName(String className)

是否是合法的java类名称

参数:

className - class nem

返回:

boolean

isMatch

public static boolean isMatch(String packageFilters,
                              String controllerName)

match controller package

参数:

packageFilters - package filter

controllerName - controller name

返回:

boolean

formatAndRemove

public static String formatAndRemove(String str,
                                     Map<String,String> values)

An interpreter for strings with named placeholders.

参数:

str - string to format

values - to replace

返回:

formatted string

handleHttpMethod

public static String handleHttpMethod(String method)

handle spring mvc method

参数:

method - method name

返回:

String

handleMappingValue

public static String handleMappingValue(com.thoughtworks.qdox.model.JavaAnnotation annotation)

handle spring mvc mapping value

参数:

annotation - JavaAnnotation

返回:

String

getParamsComments

public static Map<String,String> getParamsComments(com.thoughtworks.qdox.model.JavaMethod javaMethod,
                                                   String tagName,
                                                   String className)

obtain params comments

参数:

javaMethod - JavaMethod

tagName - java comments tag

className - class name

返回:

Map

getNormalTagComments

public static String getNormalTagComments(com.thoughtworks.qdox.model.JavaMethod javaMethod,
                                          String tagName,
                                          String className)

obtain java doc tags comments,like apiNote

参数:

javaMethod - JavaMethod

tagName - java comments tag

className - class name

返回:

Map

getFieldTagsValue

public static Map<String,String> getFieldTagsValue(com.thoughtworks.qdox.model.JavaField field,
                                                   DocJavaField docJavaField)

Get field tags

参数:

field - JavaField

docJavaField - DocJavaField

返回:

map

getFirstKeyAndValue

public static String getFirstKeyAndValue(Map<String,String> map)

Get the first element of a map.

参数:

map - map

返回:

String

generateId

public static String generateId(String value)

Use md5 generate id number

参数:

value - value

返回:

String

replaceNewLineToHtmlBr

public static String replaceNewLineToHtmlBr(String content)

handleJsonStr

public static String handleJsonStr(String content)

formDataToMap

public static Map<String,String> formDataToMap(List<FormData> formDataList)

javaPrimaryType

public static boolean javaPrimaryType(String type)

javaTypeToOpenApiTypeConvert

public static String javaTypeToOpenApiTypeConvert(String type)

getEscapeAndCleanComment

public static String getEscapeAndCleanComment(String comment)

Gets escape and clean comment.

参数:

comment - the comment

返回:

the escape and clean comment

getRequestMappingUrl

public static String getRequestMappingUrl(com.thoughtworks.qdox.model.JavaAnnotation annotation)

Get the url from 'value' or 'path' attribute

参数:

annotation - RequestMapping GetMapping PostMapping etc.

返回:

the url