- java.lang.Object
-
- net.oneandone.neberus.util.JavaDocUtils
-
public abstract class JavaDocUtils extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringJACKSON_XML_ROOT_ELEMENTstatic java.lang.StringXML_ROOT_ELEMENTstatic java.lang.StringXML_TRANSIENT
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static javax.lang.model.element.ElementasElement(javax.lang.model.type.TypeMirror typeMirror, jdk.javadoc.doclet.DocletEnvironment environment)static booleancontainedFieldNamesAreNotAvailableOrPackageExcluded(javax.lang.model.type.TypeMirror fieldType, Options options)static <T> TextractValue(javax.lang.model.element.AnnotationMirror findFirst, java.lang.String key)static java.util.List<? extends javax.lang.model.element.AnnotationMirror>getAnnotationDesc(javax.lang.model.element.Element field, java.lang.Class annotationClass)static java.util.List<? extends javax.lang.model.element.AnnotationMirror>getAnnotationDesc(javax.lang.model.element.ExecutableElement method, java.lang.Class annotationClass, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.List<? extends javax.lang.model.element.AnnotationMirror>getAnnotationDesc(javax.lang.model.element.ExecutableElement method, java.lang.String annotationClass, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.List<? extends javax.lang.model.element.AnnotationMirror>getAnnotationDesc(javax.lang.model.element.ExecutableElement method, javax.lang.model.element.VariableElement param, java.lang.Class annotationClass, int index, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.List<? extends javax.lang.model.element.AnnotationMirror>getAnnotationDesc(javax.lang.model.element.ExecutableElement method, javax.lang.model.element.VariableElement param, java.lang.String annotationClass, int index, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.List<? extends javax.lang.model.element.AnnotationMirror>getAnnotationDesc(javax.lang.model.element.TypeElement clazz, java.lang.Class annotationClass, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.List<? extends javax.lang.model.element.AnnotationMirror>getAnnotations(javax.lang.model.element.ExecutableElement method, javax.lang.model.element.VariableElement parameter, int index, jdk.javadoc.doclet.DocletEnvironment environment)static <T> TgetAnnotationValue(java.util.List<? extends javax.lang.model.element.AnnotationMirror> annotationMirrors, java.lang.String annotationClass, java.lang.String key)static <T> TgetAnnotationValue(javax.lang.model.element.ExecutableElement method, java.lang.Class annotationClass, java.lang.String key, jdk.javadoc.doclet.DocletEnvironment environment)static <T> TgetAnnotationValue(javax.lang.model.element.ExecutableElement method, java.lang.String annotationClass, java.lang.String key, jdk.javadoc.doclet.DocletEnvironment environment)static <T> TgetAnnotationValue(javax.lang.model.element.ExecutableElement method, javax.lang.model.element.VariableElement param, java.lang.Class annotationClass, int index, java.lang.String key, jdk.javadoc.doclet.DocletEnvironment environment)static <T> TgetAnnotationValue(javax.lang.model.element.ExecutableElement method, javax.lang.model.element.VariableElement parameter, java.lang.Class annotationClass, java.lang.String key, int index, jdk.javadoc.doclet.DocletEnvironment environment)static <T> TgetAnnotationValue(javax.lang.model.element.ExecutableElement method, javax.lang.model.element.VariableElement param, java.lang.String annotationClass, int index, java.lang.String key, jdk.javadoc.doclet.DocletEnvironment environment)static <T> TgetAnnotationValue(javax.lang.model.element.TypeElement clazz, java.lang.Class annotationClass, java.lang.String key, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.List<? extends com.sun.source.doctree.DocTree>getBlockTags(javax.lang.model.element.Element parameter, jdk.javadoc.doclet.DocletEnvironment environment)static java.lang.StringgetCommentText(javax.lang.model.element.Element element, jdk.javadoc.doclet.DocletEnvironment environment, boolean stripInlineTags)static java.lang.StringgetCommentTextFromInterfaceOrClass(javax.lang.model.element.ExecutableElement method, jdk.javadoc.doclet.DocletEnvironment environment, boolean stripInlineTags)static java.lang.StringgetCommentTextFromInterfaceOrClass(javax.lang.model.element.TypeElement clazz, jdk.javadoc.doclet.DocletEnvironment environment, boolean stripInlineTags)static java.lang.StringgetCommentTextWithoutInlineTags(java.util.List<? extends com.sun.source.doctree.DocTree> description)static java.util.List<javax.lang.model.element.ExecutableElement>getConstructors(javax.lang.model.element.Element element)static java.util.List<javax.lang.model.element.ExecutableElement>getConstructors(javax.lang.model.type.TypeMirror typeMirror, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror>getDataFields(javax.lang.model.type.TypeMirror type, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror>getDataFields(RestMethodData.ParameterInfo param, jdk.javadoc.doclet.DocletEnvironment environment)static <T> TgetDirectAnnotationValue(javax.lang.model.element.Element field, java.lang.Class annotationClass, java.lang.String key)static <T> TgetDirectAnnotationValue(javax.lang.model.element.Element field, java.lang.String annotationClass, java.lang.String key)static <T> TgetDirectAnnotationValue(javax.lang.model.element.VariableElement ctorParam, java.lang.Class annotationClass, java.lang.String key)static <T> TgetDirectAnnotationValue(javax.lang.model.element.VariableElement ctorParam, java.lang.String annotationClass, java.lang.String key)static com.sun.source.doctree.DocCommentTreegetDocCommentTreeFromInterfaceOrClass(javax.lang.model.element.ExecutableElement method, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.List<javax.lang.model.element.VariableElement>getEnumValuesAsList(javax.lang.model.element.TypeElement element, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.List<javax.lang.model.element.VariableElement>getEnumValuesAsList(javax.lang.model.type.TypeMirror enumType, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.List<javax.lang.model.element.ExecutableElement>getExecutableElements(javax.lang.model.element.Element element)static javax.lang.model.type.TypeMirrorgetExtendedCollectionType(javax.lang.model.type.TypeMirror type, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.List<? extends com.sun.source.doctree.DocTree>getInlineTags(javax.lang.model.element.Element parameter, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.Optional<javax.lang.model.element.TypeElement>getInterfaceClass(javax.lang.model.element.TypeElement clazz, jdk.javadoc.doclet.DocletEnvironment environment)static java.lang.StringgetNameFromGetter(javax.lang.model.element.ExecutableElement getter, jdk.javadoc.doclet.DocletEnvironment environment)static java.lang.StringgetPackageName(javax.lang.model.element.Element element, jdk.javadoc.doclet.DocletEnvironment environment)static java.lang.StringgetPackageName(javax.lang.model.type.TypeMirror typeMirror, jdk.javadoc.doclet.DocletEnvironment environment)static com.sun.source.doctree.ParamTreegetParamTag(javax.lang.model.element.ExecutableElement method, int index, java.util.Map<java.lang.String,com.sun.source.doctree.ParamTree> paramTags, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.Map<java.lang.String,com.sun.source.doctree.ParamTree>getParamTags(javax.lang.model.element.ExecutableElement method, jdk.javadoc.doclet.DocletEnvironment environment)static java.lang.StringgetParamTreeComment(com.sun.source.doctree.ParamTree param)static java.lang.StringgetPublicName(javax.lang.model.element.Element element)static java.lang.StringgetPublicName(javax.lang.model.element.VariableElement param)static java.lang.StringgetQualifiedName(javax.lang.model.type.TypeMirror typeMirror, jdk.javadoc.doclet.DocletEnvironment environment)static javax.lang.model.element.ElementgetReferencedElement(javax.lang.model.element.Element e, com.sun.source.doctree.DocTree dtree, jdk.javadoc.doclet.DocletEnvironment environment)static java.lang.StringgetSimpleTypeName(javax.lang.model.type.TypeMirror type, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.List<? extends com.sun.source.doctree.DocTree>getTags(javax.lang.model.element.ExecutableElement method, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.List<javax.lang.model.element.TypeElement>getTypeElements(jdk.javadoc.doclet.DocletEnvironment environment)static java.lang.StringgetTypeString(javax.lang.model.type.TypeMirror type, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.List<javax.lang.model.element.VariableElement>getVisibleCtorParameters(javax.lang.model.element.ExecutableElement chosenCtor)static java.util.List<javax.lang.model.element.VariableElement>getVisibleFields(javax.lang.model.type.TypeMirror type, jdk.javadoc.doclet.DocletEnvironment environment)static java.util.List<javax.lang.model.element.ExecutableElement>getVisibleGetters(javax.lang.model.type.TypeMirror type, jdk.javadoc.doclet.DocletEnvironment environment)static booleanhasAnnotation(javax.lang.model.element.ExecutableElement method, java.lang.Class annotationClass, jdk.javadoc.doclet.DocletEnvironment environment)static booleanhasAnnotation(javax.lang.model.element.ExecutableElement method, java.lang.String annotationClass, jdk.javadoc.doclet.DocletEnvironment environment)static booleanhasAnnotation(javax.lang.model.element.ExecutableElement method, javax.lang.model.element.VariableElement parameter, java.lang.Class annotationClass, int index, jdk.javadoc.doclet.DocletEnvironment environment)static booleanhasAnnotation(javax.lang.model.element.TypeElement clazz, java.lang.Class annotationClass, jdk.javadoc.doclet.DocletEnvironment environment)static booleanhasDirectAnnotation(javax.lang.model.element.VariableElement param, java.lang.Class annotationClass)static booleanhasDirectAnnotation(javax.lang.model.element.VariableElement param, java.lang.String annotationClass)static booleanisArrayType(javax.lang.model.type.TypeMirror type)static booleanisCollectionType(javax.lang.model.type.TypeMirror type)static booleanisEnum(javax.lang.model.type.TypeMirror typeMirror, jdk.javadoc.doclet.DocletEnvironment environment)static booleanisJavaType(javax.lang.model.type.TypeMirror type, jdk.javadoc.doclet.DocletEnvironment environment)static booleanisMapType(javax.lang.model.type.TypeMirror type)static booleantypeCantBeDocumented(javax.lang.model.type.TypeMirror type, Options options)
-
-
-
Field Detail
-
XML_TRANSIENT
public static final java.lang.String XML_TRANSIENT
- See Also:
- Constant Field Values
-
XML_ROOT_ELEMENT
public static final java.lang.String XML_ROOT_ELEMENT
- See Also:
- Constant Field Values
-
JACKSON_XML_ROOT_ELEMENT
public static final java.lang.String JACKSON_XML_ROOT_ELEMENT
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAnnotationDesc
public static java.util.List<? extends javax.lang.model.element.AnnotationMirror> getAnnotationDesc(javax.lang.model.element.TypeElement clazz, java.lang.Class annotationClass, jdk.javadoc.doclet.DocletEnvironment environment)
-
getAnnotationDesc
public static java.util.List<? extends javax.lang.model.element.AnnotationMirror> getAnnotationDesc(javax.lang.model.element.ExecutableElement method, java.lang.Class annotationClass, jdk.javadoc.doclet.DocletEnvironment environment)
-
getAnnotationDesc
public static java.util.List<? extends javax.lang.model.element.AnnotationMirror> getAnnotationDesc(javax.lang.model.element.ExecutableElement method, java.lang.String annotationClass, jdk.javadoc.doclet.DocletEnvironment environment)
-
getAnnotationDesc
public static java.util.List<? extends javax.lang.model.element.AnnotationMirror> getAnnotationDesc(javax.lang.model.element.ExecutableElement method, javax.lang.model.element.VariableElement param, java.lang.Class annotationClass, int index, jdk.javadoc.doclet.DocletEnvironment environment)
-
getAnnotationDesc
public static java.util.List<? extends javax.lang.model.element.AnnotationMirror> getAnnotationDesc(javax.lang.model.element.ExecutableElement method, javax.lang.model.element.VariableElement param, java.lang.String annotationClass, int index, jdk.javadoc.doclet.DocletEnvironment environment)
-
getAnnotationDesc
public static java.util.List<? extends javax.lang.model.element.AnnotationMirror> getAnnotationDesc(javax.lang.model.element.Element field, java.lang.Class annotationClass)
-
getAnnotationValue
public static <T> T getAnnotationValue(java.util.List<? extends javax.lang.model.element.AnnotationMirror> annotationMirrors, java.lang.String annotationClass, java.lang.String key)
-
getAnnotationValue
public static <T> T getAnnotationValue(javax.lang.model.element.TypeElement clazz, java.lang.Class annotationClass, java.lang.String key, jdk.javadoc.doclet.DocletEnvironment environment)
-
getAnnotationValue
public static <T> T getAnnotationValue(javax.lang.model.element.ExecutableElement method, java.lang.Class annotationClass, java.lang.String key, jdk.javadoc.doclet.DocletEnvironment environment)
-
getAnnotationValue
public static <T> T getAnnotationValue(javax.lang.model.element.ExecutableElement method, java.lang.String annotationClass, java.lang.String key, jdk.javadoc.doclet.DocletEnvironment environment)
-
getDirectAnnotationValue
public static <T> T getDirectAnnotationValue(javax.lang.model.element.Element field, java.lang.Class annotationClass, java.lang.String key)
-
getDirectAnnotationValue
public static <T> T getDirectAnnotationValue(javax.lang.model.element.Element field, java.lang.String annotationClass, java.lang.String key)
-
getAnnotationValue
public static <T> T getAnnotationValue(javax.lang.model.element.ExecutableElement method, javax.lang.model.element.VariableElement param, java.lang.Class annotationClass, int index, java.lang.String key, jdk.javadoc.doclet.DocletEnvironment environment)
-
getAnnotationValue
public static <T> T getAnnotationValue(javax.lang.model.element.ExecutableElement method, javax.lang.model.element.VariableElement param, java.lang.String annotationClass, int index, java.lang.String key, jdk.javadoc.doclet.DocletEnvironment environment)
-
getDirectAnnotationValue
public static <T> T getDirectAnnotationValue(javax.lang.model.element.VariableElement ctorParam, java.lang.Class annotationClass, java.lang.String key)
-
getDirectAnnotationValue
public static <T> T getDirectAnnotationValue(javax.lang.model.element.VariableElement ctorParam, java.lang.String annotationClass, java.lang.String key)
-
getAnnotationValue
public static <T> T getAnnotationValue(javax.lang.model.element.ExecutableElement method, javax.lang.model.element.VariableElement parameter, java.lang.Class annotationClass, java.lang.String key, int index, jdk.javadoc.doclet.DocletEnvironment environment)
-
getAnnotations
public static java.util.List<? extends javax.lang.model.element.AnnotationMirror> getAnnotations(javax.lang.model.element.ExecutableElement method, javax.lang.model.element.VariableElement parameter, int index, jdk.javadoc.doclet.DocletEnvironment environment)
-
hasDirectAnnotation
public static boolean hasDirectAnnotation(javax.lang.model.element.VariableElement param, java.lang.Class annotationClass)
-
hasDirectAnnotation
public static boolean hasDirectAnnotation(javax.lang.model.element.VariableElement param, java.lang.String annotationClass)
-
getInterfaceClass
public static java.util.Optional<javax.lang.model.element.TypeElement> getInterfaceClass(javax.lang.model.element.TypeElement clazz, jdk.javadoc.doclet.DocletEnvironment environment)
-
extractValue
public static <T> T extractValue(javax.lang.model.element.AnnotationMirror findFirst, java.lang.String key)
-
hasAnnotation
public static boolean hasAnnotation(javax.lang.model.element.ExecutableElement method, javax.lang.model.element.VariableElement parameter, java.lang.Class annotationClass, int index, jdk.javadoc.doclet.DocletEnvironment environment)
-
hasAnnotation
public static boolean hasAnnotation(javax.lang.model.element.ExecutableElement method, java.lang.Class annotationClass, jdk.javadoc.doclet.DocletEnvironment environment)
-
hasAnnotation
public static boolean hasAnnotation(javax.lang.model.element.ExecutableElement method, java.lang.String annotationClass, jdk.javadoc.doclet.DocletEnvironment environment)
-
hasAnnotation
public static boolean hasAnnotation(javax.lang.model.element.TypeElement clazz, java.lang.Class annotationClass, jdk.javadoc.doclet.DocletEnvironment environment)
-
getCommentTextFromInterfaceOrClass
public static java.lang.String getCommentTextFromInterfaceOrClass(javax.lang.model.element.TypeElement clazz, jdk.javadoc.doclet.DocletEnvironment environment, boolean stripInlineTags)
-
getCommentTextFromInterfaceOrClass
public static java.lang.String getCommentTextFromInterfaceOrClass(javax.lang.model.element.ExecutableElement method, jdk.javadoc.doclet.DocletEnvironment environment, boolean stripInlineTags)
-
getDocCommentTreeFromInterfaceOrClass
public static com.sun.source.doctree.DocCommentTree getDocCommentTreeFromInterfaceOrClass(javax.lang.model.element.ExecutableElement method, jdk.javadoc.doclet.DocletEnvironment environment)
-
getParamTag
public static com.sun.source.doctree.ParamTree getParamTag(javax.lang.model.element.ExecutableElement method, int index, java.util.Map<java.lang.String,com.sun.source.doctree.ParamTree> paramTags, jdk.javadoc.doclet.DocletEnvironment environment)
-
getParamTags
public static java.util.Map<java.lang.String,com.sun.source.doctree.ParamTree> getParamTags(javax.lang.model.element.ExecutableElement method, jdk.javadoc.doclet.DocletEnvironment environment)
-
getParamTreeComment
public static java.lang.String getParamTreeComment(com.sun.source.doctree.ParamTree param)
-
getTags
public static java.util.List<? extends com.sun.source.doctree.DocTree> getTags(javax.lang.model.element.ExecutableElement method, jdk.javadoc.doclet.DocletEnvironment environment)
-
containedFieldNamesAreNotAvailableOrPackageExcluded
public static boolean containedFieldNamesAreNotAvailableOrPackageExcluded(javax.lang.model.type.TypeMirror fieldType, Options options)
-
getPublicName
public static java.lang.String getPublicName(javax.lang.model.element.VariableElement param)
-
getDataFields
public static java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror> getDataFields(RestMethodData.ParameterInfo param, jdk.javadoc.doclet.DocletEnvironment environment)
-
getDataFields
public static java.util.Map<java.lang.String,javax.lang.model.type.TypeMirror> getDataFields(javax.lang.model.type.TypeMirror type, jdk.javadoc.doclet.DocletEnvironment environment)
-
isArrayType
public static boolean isArrayType(javax.lang.model.type.TypeMirror type)
-
isCollectionType
public static boolean isCollectionType(javax.lang.model.type.TypeMirror type)
-
getExtendedCollectionType
public static javax.lang.model.type.TypeMirror getExtendedCollectionType(javax.lang.model.type.TypeMirror type, jdk.javadoc.doclet.DocletEnvironment environment)
-
isMapType
public static boolean isMapType(javax.lang.model.type.TypeMirror type)
-
getTypeString
public static java.lang.String getTypeString(javax.lang.model.type.TypeMirror type, jdk.javadoc.doclet.DocletEnvironment environment)
-
getSimpleTypeName
public static java.lang.String getSimpleTypeName(javax.lang.model.type.TypeMirror type, jdk.javadoc.doclet.DocletEnvironment environment)
-
getPublicName
public static java.lang.String getPublicName(javax.lang.model.element.Element element)
-
typeCantBeDocumented
public static boolean typeCantBeDocumented(javax.lang.model.type.TypeMirror type, Options options)
-
isJavaType
public static boolean isJavaType(javax.lang.model.type.TypeMirror type, jdk.javadoc.doclet.DocletEnvironment environment)
-
getVisibleFields
public static java.util.List<javax.lang.model.element.VariableElement> getVisibleFields(javax.lang.model.type.TypeMirror type, jdk.javadoc.doclet.DocletEnvironment environment)
-
getVisibleGetters
public static java.util.List<javax.lang.model.element.ExecutableElement> getVisibleGetters(javax.lang.model.type.TypeMirror type, jdk.javadoc.doclet.DocletEnvironment environment)
-
getVisibleCtorParameters
public static java.util.List<javax.lang.model.element.VariableElement> getVisibleCtorParameters(javax.lang.model.element.ExecutableElement chosenCtor)
-
getNameFromGetter
public static java.lang.String getNameFromGetter(javax.lang.model.element.ExecutableElement getter, jdk.javadoc.doclet.DocletEnvironment environment)
-
getTypeElements
public static java.util.List<javax.lang.model.element.TypeElement> getTypeElements(jdk.javadoc.doclet.DocletEnvironment environment)
-
getExecutableElements
public static java.util.List<javax.lang.model.element.ExecutableElement> getExecutableElements(javax.lang.model.element.Element element)
-
getConstructors
public static java.util.List<javax.lang.model.element.ExecutableElement> getConstructors(javax.lang.model.type.TypeMirror typeMirror, jdk.javadoc.doclet.DocletEnvironment environment)
-
getConstructors
public static java.util.List<javax.lang.model.element.ExecutableElement> getConstructors(javax.lang.model.element.Element element)
-
getCommentText
public static java.lang.String getCommentText(javax.lang.model.element.Element element, jdk.javadoc.doclet.DocletEnvironment environment, boolean stripInlineTags)
-
getCommentTextWithoutInlineTags
public static java.lang.String getCommentTextWithoutInlineTags(java.util.List<? extends com.sun.source.doctree.DocTree> description)
-
isEnum
public static boolean isEnum(javax.lang.model.type.TypeMirror typeMirror, jdk.javadoc.doclet.DocletEnvironment environment)
-
getPackageName
public static java.lang.String getPackageName(javax.lang.model.type.TypeMirror typeMirror, jdk.javadoc.doclet.DocletEnvironment environment)
-
getPackageName
public static java.lang.String getPackageName(javax.lang.model.element.Element element, jdk.javadoc.doclet.DocletEnvironment environment)
-
getQualifiedName
public static java.lang.String getQualifiedName(javax.lang.model.type.TypeMirror typeMirror, jdk.javadoc.doclet.DocletEnvironment environment)
-
asElement
public static javax.lang.model.element.Element asElement(javax.lang.model.type.TypeMirror typeMirror, jdk.javadoc.doclet.DocletEnvironment environment)
-
getEnumValuesAsList
public static java.util.List<javax.lang.model.element.VariableElement> getEnumValuesAsList(javax.lang.model.type.TypeMirror enumType, jdk.javadoc.doclet.DocletEnvironment environment)
-
getEnumValuesAsList
public static java.util.List<javax.lang.model.element.VariableElement> getEnumValuesAsList(javax.lang.model.element.TypeElement element, jdk.javadoc.doclet.DocletEnvironment environment)
-
getBlockTags
public static java.util.List<? extends com.sun.source.doctree.DocTree> getBlockTags(javax.lang.model.element.Element parameter, jdk.javadoc.doclet.DocletEnvironment environment)
-
getInlineTags
public static java.util.List<? extends com.sun.source.doctree.DocTree> getInlineTags(javax.lang.model.element.Element parameter, jdk.javadoc.doclet.DocletEnvironment environment)
-
getReferencedElement
public static javax.lang.model.element.Element getReferencedElement(javax.lang.model.element.Element e, com.sun.source.doctree.DocTree dtree, jdk.javadoc.doclet.DocletEnvironment environment)
-
-