org.lastaflute.doc.generator

クラス ActionDocumentGenerator

java.lang.Object

org.lastaflute.doc.generator.BaseDocumentGenerator

org.lastaflute.doc.generator.ActionDocumentGenerator

public class ActionDocumentGenerator
extends BaseDocumentGenerator

導入されたバージョン:

0.5.0-sp9 of UTFlute (2015/09/18 Friday)

作成者:

p1us2er0, jflute

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected int	depth depth.
protected static List<Class<?>>	NATIVE_TYPE_LIST
protected org.dbflute.optional.OptionalThing<SourceParserReflector>	sourceParserReflector The optional reflector of source parser, e.g. java parser.
protected List<String>	srcDirList The list of source directory.
protected static Set<String>	SUPPRESSED_FIELD_SET list of suppressed fields, e.g. enhanced fields by JaCoCo.

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
ActionDocumentGenerator(List<String> srcDirList, int depth, org.dbflute.optional.OptionalThing<SourceParserReflector> sourceParserReflector)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected String	adjustFieldName(Class<?> clazz, Field field)
protected TypeDocMeta	analyzeFormClass(org.lastaflute.web.ruts.config.ActionFormMeta actionFormMeta)
protected TypeDocMeta	analyzeReturnClass(Method method)
protected String	buildEnumValuesExp(Class<?> typeClass)
protected String	calculateName(String parentName, String name, String type)
protected Map<String,String>	convertPropertyNameMap(String parentName, TypeDocMeta typeDocMeta)
protected ActionDocMeta	createActionDocMeta(org.lastaflute.web.ruts.config.ActionExecute execute)
protected TypeDocMeta	createTypeDocMeta(Class<?> clazz, Map<String,Type> genericParameterTypesMap, int depth, Field field)
protected boolean	exceptsActionExecute(org.lastaflute.web.ruts.config.ActionExecute actionExecute)
protected String	extractActionClassName(Path path, String srcDir)
protected String	extractJsonResponseIterableElementTypeName(String returnTypeName)
protected List<String>	findActionComponentNameList()
List<ActionDocMeta>	generateActionDocMetaList()
Map<String,Map<String,String>>	generateActionPropertyNameMap(List<ActionDocMeta> actionDocMetaList)
protected org.lastaflute.web.path.ActionPathResolver	getActionPathResolver()
protected List<Class<?>>	getNativeClassList()
protected List<String>	getTargetTypeSuffixNameList()
protected List<TypeDocMeta>	prepareTypeDocMetaList(Class<?> clazz, Map<String,Type> genericParameterTypesMap, int depth)
protected String	resolveIterableElementTypeReflectiveTypeName(String extracted)
protected boolean	suppressActionExecute(org.lastaflute.web.ruts.config.ActionExecute actionExecute) 非推奨です。
protected boolean	suppressField(Field field)
protected void	throwDocIterableElementTypeNotFoundException(String genericClassName, String returnTypeName, Method method, TypeDocMeta returnTypeDocMeta, RuntimeException e)

クラスから継承されたメソッド org.lastaflute.doc.generator.BaseDocumentGenerator

adjustSimpleTypeName, adjustSimpleTypeName, adjustTypeName, adjustTypeName, analyzeAnnotationList

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

SUPPRESSED_FIELD_SET

protected static final Set<String> SUPPRESSED_FIELD_SET

list of suppressed fields, e.g. enhanced fields by JaCoCo.

NATIVE_TYPE_LIST

protected static final List<Class<?>> NATIVE_TYPE_LIST

srcDirList

protected final List<String> srcDirList

The list of source directory. (NotNull)

depth

protected int depth

depth.

sourceParserReflector

protected final org.dbflute.optional.OptionalThing<SourceParserReflector> sourceParserReflector

The optional reflector of source parser, e.g. java parser. (NotNull, EmptyAllowed)

コンストラクタの詳細

ActionDocumentGenerator

public ActionDocumentGenerator(List<String> srcDirList,
                               int depth,
                               org.dbflute.optional.OptionalThing<SourceParserReflector> sourceParserReflector)

メソッドの詳細

generateActionDocMetaList

public List<ActionDocMeta> generateActionDocMetaList()

exceptsActionExecute

protected boolean exceptsActionExecute(org.lastaflute.web.ruts.config.ActionExecute actionExecute)

suppressActionExecute

@Deprecated
protected boolean suppressActionExecute(org.lastaflute.web.ruts.config.ActionExecute actionExecute)

非推奨です。

findActionComponentNameList

protected List<String> findActionComponentNameList()

extractActionClassName

protected String extractActionClassName(Path path,
                                        String srcDir)

createActionDocMeta

protected ActionDocMeta createActionDocMeta(org.lastaflute.web.ruts.config.ActionExecute execute)

getActionPathResolver

protected org.lastaflute.web.path.ActionPathResolver getActionPathResolver()

analyzeFormClass

protected TypeDocMeta analyzeFormClass(org.lastaflute.web.ruts.config.ActionFormMeta actionFormMeta)

analyzeReturnClass

protected TypeDocMeta analyzeReturnClass(Method method)

extractJsonResponseIterableElementTypeName

protected String extractJsonResponseIterableElementTypeName(String returnTypeName)

resolveIterableElementTypeReflectiveTypeName

protected String resolveIterableElementTypeReflectiveTypeName(String extracted)

getNativeClassList

protected List<Class<?>> getNativeClassList()

throwDocIterableElementTypeNotFoundException

protected void throwDocIterableElementTypeNotFoundException(String genericClassName,
                                                            String returnTypeName,
                                                            Method method,
                                                            TypeDocMeta returnTypeDocMeta,
                                                            RuntimeException e)

prepareTypeDocMetaList

protected List<TypeDocMeta> prepareTypeDocMetaList(Class<?> clazz,
                                                   Map<String,Type> genericParameterTypesMap,
                                                   int depth)

suppressField

protected boolean suppressField(Field field)

createTypeDocMeta

protected TypeDocMeta createTypeDocMeta(Class<?> clazz,
                                        Map<String,Type> genericParameterTypesMap,
                                        int depth,
                                        Field field)

adjustFieldName

protected String adjustFieldName(Class<?> clazz,
                                 Field field)

buildEnumValuesExp

protected String buildEnumValuesExp(Class<?> typeClass)

getTargetTypeSuffixNameList

protected List<String> getTargetTypeSuffixNameList()

generateActionPropertyNameMap

public Map<String,Map<String,String>> generateActionPropertyNameMap(List<ActionDocMeta> actionDocMetaList)

convertPropertyNameMap

protected Map<String,String> convertPropertyNameMap(String parentName,
                                                    TypeDocMeta typeDocMeta)

calculateName

protected String calculateName(String parentName,
                               String name,
                               String type)