dev.jeka.core.tool

Class JkBeanDescription

java.lang.Object

dev.jeka.core.tool.JkBeanDescription

public final class JkBeanDescription
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkBeanDescription.BeanField Definition for Jeka class option.
static class	JkBeanDescription.BeanMethod Definition of method in a given class that can be called by Jeka.
static class	JkBeanDescription.InitMethodInfo
static class	JkBeanDescription.MdContent

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<JkBeanDescription.BeanField>	beanFields
java.util.List<JkBeanDescription.BeanMethod>	beanMethods
java.lang.String	initDescription
static java.util.List<java.lang.Class<? extends KBean>>	STANDARD_KBEAN_CLASSES
java.lang.String	synopsisDetail
java.lang.String	synopsisHeader

Method Summary

Modifier and Type	Method and Description
static JkBeanDescription	of(java.lang.Class<? extends KBean> kbeanClass)
JkBeanDescription.MdContent	toMdContent() Generates markdown content describing the bean, including its fields, methods, and initialization details.

Methods inherited from class java.lang.Object

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

Field Detail

STANDARD_KBEAN_CLASSES

public static final java.util.List<java.lang.Class<? extends KBean>> STANDARD_KBEAN_CLASSES

synopsisHeader

public final java.lang.String synopsisHeader

synopsisDetail

public final java.lang.String synopsisDetail

beanMethods

public final java.util.List<JkBeanDescription.BeanMethod> beanMethods

beanFields

public final java.util.List<JkBeanDescription.BeanField> beanFields

initDescription

public final java.lang.String initDescription

Method Detail

of

public static JkBeanDescription of(java.lang.Class<? extends KBean> kbeanClass)

toMdContent

public JkBeanDescription.MdContent toMdContent()

Generates markdown content describing the bean, including its fields, methods, and initialization details. The generated content is formatted as a markdown table.

Returns:

A formatted string in markdown representing the bean's information including its fields, methods, and initialization description if available.