Package org.jdrupes.mdoclet.internal.doclets.toolkit.util

Klasse Utils

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.util.Utils

public class Utils
extends Object

Utilities Class for Doclets.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static enum	Utils.DeclarationPreviewLanguageFeatures
static enum	Utils.ElementFlag	An element can have flags that place it into some subcategories, like being a preview or a deprecated element.
static final record	Utils.OverrideInfo
static class	Utils.Pair<K,L>	A container holding a pair of values (tuple).
static interface	Utils.PreviewFlagProvider
static final class	Utils.PreviewSummary

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
final Comparators	comparators
final BaseConfiguration	configuration
final DocTrees	docTrees
final Elements	elementUtils
final Types	typeUtils

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
Utils(BaseConfiguration c)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
TypeMirror	asInstantiatedFieldType(TypeElement site, VariableElement ve)	Returns the TypeMirror corresponding to the type of the field declaration seen as a member of a given declared type.
ExecutableType	asInstantiatedMethodType(TypeElement site, ExecutableElement ee)	Returns the ExecutableType corresponding to the type of the method declaration seen as a member of a given declared type.
TypeElement	asTypeElement(TypeMirror t)	Return this type as a TypeElement if it represents a class interface or annotation.
void	checkJavaScriptInOption(String name, String value)
int	compareStrings(String s1, String s2)	A general purpose case insensitive String comparator, which compares two Strings using a Collator strength of “TERTIARY”.
String	constantValueExpression(VariableElement ve)
ModuleElement	containingModule(Element e)
PackageElement	containingPackage(Element e)
Utils.PreviewSummary	declaredUsingPreviewAPIs(Element el)
boolean	definesSerializableFields(TypeElement aclass)
DocFinder	docFinder()
Set<Utils.ElementFlag>	elementFlags(Element el)	Return all flags for the given Element.
SortedSet<TypeElement>	filterOutPrivateClasses(Iterable<TypeElement> classlist, boolean javafx)	In case of JavaFX mode on, filters out classes that are private, package private, these are not documented in JavaFX mode, also remove those classes that have @hidden or @treatAsPrivate comment tag.
TypeElement	findClass(Element element, String className)	TODO: FIXME: port to javax.lang.model Find a class within the context of this class.
TypeElement	findClassInPackageElement(PackageElement pkg, String className)	Lookup for a class within this package.
String	flatSignature(ExecutableElement e, TypeElement site)	Get the flat signature of an executable element with simple (unqualified) parameter types in the context of type element site.
SortedSet<TypeElement>	getAllClasses(PackageElement pkg)	Returns a sorted set containing the documented classes and interfaces in a package.
SortedSet<TypeElement>	getAllClassesUnfiltered(PackageElement pkg)	Returns all the classes in a package.
Set<TypeMirror>	getAllInterfaces(TypeElement te)	Returns all the implemented superinterfaces of a given type, in the case of classes, include all the superinterfaces of the supertype.
List<Element>	getAnnotationMembers(TypeElement te)	Returns the fields and methods declared in an annotation interface.
List<? extends DocTree>	getBlockTags(DocCommentTree dcTree)
List<? extends DocTree>	getBlockTags(Element element)
List<? extends DocTree>	getBlockTags(Element element, DocTree.Kind kind)
<T extends DocTree> List<? extends T>	getBlockTags(Element element, DocTree.Kind kind, Class<T> tClass)
List<? extends DocTree>	getBlockTags(Element element, Predicate<DocTree> filter)
<T extends DocTree> List<T>	getBlockTags(Element element, Predicate<DocTree> filter, Class<T> tClass)
List<? extends DocTree>	getBlockTags(Element element, Taglet taglet)
List<? extends DocTree>	getBody(Element element)
List<? extends TypeMirror>	getBounds(TypeParameterElement tpe)
List<TypeElement>	getClasses(Element e)	Returns the documented classes in an element, such as a package element or type element.
CommentHelper	getCommentHelper(Element element)
TypeMirror	getComponentType(TypeMirror t)
List<ExecutableElement>	getConstructors(TypeElement te)	Returns the documented constructors in a type element.
TypeMirror	getDeclaredType(Collection<TypeMirror> values, TypeElement enclosing, TypeMirror target)	Finds the declaration of the enclosing’s type parameter.
TypeMirror	getDeclaredType(TypeElement enclosing, TypeMirror target)
Map<ModuleElement,String>	getDependentModules(ModuleElement mdle)
String	getDeprecatedSince(Element e)	Returns the value of the Deprecated.since element if it is set on the given Element.
List<? extends DeprecatedTree>	getDeprecatedTrees(Element element)
TypeMirror	getDeprecatedType()
String	getDimension(TypeMirror t)	Return the type’s dimension information, as a string.
DocCommentTree	getDocCommentTree(Element element)
DocCommentTree	getDocCommentTree0(Element element)	Retrieves the doc comments for a given element.
Iterable<TypeElement>	getEnclosedTypeElements(PackageElement pkg)	Returns the recursively enclosed documented type elements in a package
TypeElement	getEnclosingTypeElement(Element e)
List<VariableElement>	getEnumConstants(TypeElement te)	Returns the documented enum constants in a type element.
TypeMirror	getExternalizableType()
List<VariableElement>	getFields(TypeElement te)	Returns the documented fields in a type element.
List<VariableElement>	getFieldsUnfiltered(TypeElement te)	Returns the fields in a type element.
FileObject	getFileObject(TypeElement te)
List<? extends DocTree>	getFirstSentenceTrees(Element element)
TypeMirror	getFirstVisibleSuperClass(TypeElement te)	Given a class, return the closest visible superclass.
TypeMirror	getFirstVisibleSuperClass(TypeMirror type)	Given a class, return the closest visible superclass.
TypeElement	getFirstVisibleSuperClassAsTypeElement(TypeElement te)
List<? extends DocTree>	getFullBody(Element element)
String	getFullyQualifiedName(Element e)	A generic utility which returns the fully qualified names of an entity, if the entity is not qualifiable then its enclosing entity, it is up to the caller to add the elements name as required.
String	getFullyQualifiedName(Element e, boolean outer)
TypeMirror	getFunctionalInterface()
String	getHTMLTitle(Element element)
long	getLineNumber(Element e)
JavaFileManager.Location	getLocationForModule(ModuleElement mdle)
JavaFileManager.Location	getLocationForPackage(PackageElement pd)
List<ExecutableElement>	getMethods(TypeElement te)	Returns the documented methods in a type element.
String	getModifiers(ModuleElement.RequiresDirective rd)
String	getModuleName(ModuleElement mdle)	Get the module name for a given module element.
Map<ModuleElement,Set<PackageElement>>	getModulePackageMap()
TypeMirror	getObjectType()
String	getPackageName(PackageElement pkg)	Get the package name for a given package element.
List<ParamTree>	getParamTrees(Element element)
List<? extends DocTree>	getPreamble(Element element)
Object	getPreviewFeature(Element e)	Returns the value of the internal PreviewFeature.feature element.
String	getPropertyLabel(String name)
String	getPropertyName(String name)
List<? extends ProvidesTree>	getProvidesTrees(Element element)
String	getQualifiedTypeName(TypeMirror t)	Get the qualified type name of a TypeMirror compatible with the Element’s getQualified name, returns the qualified name of the Reference type otherwise the primitive name.
List<? extends ReturnTree>	getReturnTrees(Element element)
TypeMirror	getReturnType(TypeElement site, ExecutableElement ee)	Returns the TypeMirror of the ExecutableElement if it is a method, or null if it is a constructor.
List<? extends SeeTree>	getSeeTrees(Element element)
List<? extends SerialDataTree>	getSerialDataTrees(ExecutableElement member)
List<? extends SerialFieldTree>	getSerialFieldTrees(VariableElement field)
TypeMirror	getSerializableType()
List<? extends SerialTree>	getSerialTrees(Element element)
String	getSimpleName(Element e)	Returns the name of the element after the last dot of the package name.
List<? extends SpecTree>	getSpecTrees(Element element)
TypeMirror	getSymbol(String signature)
TypeMirror	getThrowableType()
List<ThrowsTree>	getThrowsTrees(Element element)
TreePath	getTreePath(Element e)	Gets a TreePath for an Element.
String	getTypeElementKindName(TypeElement te, boolean lowerCaseOnly)	Returns the name of the kind of a type element (Class, Interface, etc.).
SortedSet<TypeElement>	getTypeElementsAsSortedSet(Iterable<TypeElement> typeElements)
String	getTypeName(TypeMirror t, boolean fullyQualified)
List<ParamTree>	getTypeParamTrees(Element element)
String	getTypeSignature(TypeMirror t, boolean qualifiedName, boolean noTypeParameters)
List<? extends UsesTree>	getUsesTrees(Element element)
boolean	hasBlockTag(Element element, DocTree.Kind kind)
boolean	hasBlockTag(Element element, DocTree.Kind kind, String tagName)
boolean	hasDocCommentTree(Element element)	Checks whether an element has an associated doc comment.
boolean	hasHiddenTag(Element e)	Returns true if the element is included or selected, contains @hidden tag, or if javafx flag is present and element contains @treatAsPrivate tag.
boolean	ignoreBounds(TypeMirror bound)
boolean	isAbstract(Element e)
boolean	isAnnotated(TypeMirror e)
boolean	isAnnotationInterface(Element e)
boolean	isArrayType(TypeMirror t)
boolean	isCanonicalRecordConstructor(ExecutableElement ee)
boolean	isClass(Element e)
boolean	isConstructor(Element e)
boolean	isCoreClass(TypeElement e)	According to The Java Language Specification, all the outer classes and static inner classes are core classes.
boolean	isDeclaredType(TypeMirror t)
boolean	isDefault(Element e)
boolean	isDeprecated(Element e)	Return true if the given Element is deprecated.
boolean	isDeprecatedForRemoval(Element e)	Returns true if the given Element is deprecated for removal.
boolean	isDocumentedAnnotation(TypeElement annotation)	Given an annotation, return true if it should be documented and false otherwise.
boolean	isEnclosingPackageIncluded(TypeElement te)
boolean	isEnum(Element e)
boolean	isExecutableElement(Element e)
boolean	isExternalizable(TypeElement e)
boolean	isField(Element e)
boolean	isFinal(Element e)
boolean	isFunctionalInterface(AnnotationMirror amirror)
boolean	isGenericType(TypeMirror type)	Returns true if type or any of its enclosing types has non-empty type arguments.
boolean	isIncluded(Element e)
boolean	isInterface(Element e)
boolean	isLinkable(TypeElement typeElem)	Returns true if this class is linkable and false if we can’t link to it.
boolean	isLinkable(TypeElement typeElem, Element elem)	Returns true if an element is linkable in the context of a given type element.
boolean	isMethod(Element e)
boolean	isModule(Element e)
boolean	isNonThrowableClass(TypeElement te)
boolean	isOverviewElement(Element e)
boolean	isPackage(Element e)
boolean	isPackagePrivate(Element e)
boolean	isPlainInterface(Element e)
boolean	isPreviewAPI(Element el)	Checks whether the given Element should be marked as a preview API.
boolean	isPrivate(Element e)
boolean	isProperty(String name)
boolean	isProtected(Element e)
boolean	isPublic(Element e)
boolean	isRecord(TypeElement e)
boolean	isReflectivePreviewAPI(Element el)	Checks whether the given Element should be marked as a reflective preview API.
boolean	isSerializable(TypeElement e)
boolean	isSimpleOverride(ExecutableElement m)
boolean	isSpecified(Element e)
boolean	isStatic(Element e)
boolean	isThrowable(TypeElement te)
boolean	isTypeElement(Element e)
boolean	isTypeParameterElement(Element e)
boolean	isTypeVariable(TypeMirror t)
boolean	isUndocumentedEnclosure(TypeElement enclosingTypeElement)
boolean	isVariableElement(Element e)
boolean	isVoid(TypeMirror t)
String	makeSignature(ExecutableElement e, TypeElement site, boolean full)
String	makeSignature(ExecutableElement e, TypeElement site, boolean full, boolean ignoreTypeParameters)
Utils.OverrideInfo	overriddenMethod(ExecutableElement method)
Set<Utils.DeclarationPreviewLanguageFeatures>	previewLanguageFeaturesUsed(Element e)	Return the set of preview language features used to declare the given element.
String	propertyName(ExecutableElement e)	A convenience method to get property name from the name of the getter or setter method.
void	removeCommentHelper(Element element)
String	replaceTabs(String text)	Replace all tabs in a string with the appropriate number of spaces.
SortedSet<VariableElement>	serializableFields(TypeElement aclass)
SortedSet<ExecutableElement>	serializationMethods(TypeElement aclass)
Utils.PreviewFlagProvider	setPreviewFlagProvider(Utils.PreviewFlagProvider provider)
boolean	shouldDocument(Element e)
String	signature(ExecutableElement e, TypeElement site)	Get the signature of an executable element with qualified parameter types in the context of type element site.
static String	toLowerCase(String s)	Returns a locale independent lower cased String.

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

configuration

public final BaseConfiguration configuration

docTrees

public final DocTrees docTrees

elementUtils

public final Elements elementUtils

typeUtils

public final Types typeUtils

comparators

public final Comparators comparators

Konstruktordetails

Utils

public Utils(BaseConfiguration c)

Methodendetails

getSymbol

public TypeMirror getSymbol(String signature)

getObjectType

public TypeMirror getObjectType()

getThrowableType

public TypeMirror getThrowableType()

getSerializableType

public TypeMirror getSerializableType()

getExternalizableType

public TypeMirror getExternalizableType()

getDeprecatedType

public TypeMirror getDeprecatedType()

getFunctionalInterface

public TypeMirror getFunctionalInterface()

isCoreClass

public boolean isCoreClass(TypeElement e)

According to The Java Language Specification, all the outer classes and static inner classes are core classes.

getLocationForPackage

public JavaFileManager.Location getLocationForPackage(PackageElement pd)

getLocationForModule

public JavaFileManager.Location getLocationForModule(ModuleElement mdle)

isAnnotated

public boolean isAnnotated(TypeMirror e)

isAnnotationInterface

public boolean isAnnotationInterface(Element e)

isClass

public boolean isClass(Element e)

isInterface

public boolean isInterface(Element e)

isConstructor

public boolean isConstructor(Element e)

isEnum

public boolean isEnum(Element e)

isField

public boolean isField(Element e)

isPlainInterface

public boolean isPlainInterface(Element e)

isMethod

public boolean isMethod(Element e)

isModule

public boolean isModule(Element e)

isPackage

public boolean isPackage(Element e)

isAbstract

public boolean isAbstract(Element e)

isDefault

public boolean isDefault(Element e)

isFinal

public boolean isFinal(Element e)

isPackagePrivate

public boolean isPackagePrivate(Element e)

isPrivate

public boolean isPrivate(Element e)

isProtected

public boolean isProtected(Element e)

isPublic

public boolean isPublic(Element e)

isProperty

public boolean isProperty(String name)

getPropertyName

public String getPropertyName(String name)

getPropertyLabel

public String getPropertyLabel(String name)

isOverviewElement

public boolean isOverviewElement(Element e)

isStatic

public boolean isStatic(Element e)

isSerializable

public boolean isSerializable(TypeElement e)

isExternalizable

public boolean isExternalizable(TypeElement e)

isRecord

public boolean isRecord(TypeElement e)

isCanonicalRecordConstructor

public boolean isCanonicalRecordConstructor(ExecutableElement ee)

serializableFields

public SortedSet<VariableElement> serializableFields(TypeElement aclass)

serializationMethods

public SortedSet<ExecutableElement> serializationMethods(TypeElement aclass)

definesSerializableFields

public boolean definesSerializableFields(TypeElement aclass)

isFunctionalInterface

public boolean isFunctionalInterface(AnnotationMirror amirror)

isUndocumentedEnclosure

public boolean isUndocumentedEnclosure(TypeElement enclosingTypeElement)

isNonThrowableClass

public boolean isNonThrowableClass(TypeElement te)

isThrowable

public boolean isThrowable(TypeElement te)

isExecutableElement

public boolean isExecutableElement(Element e)

isVariableElement

public boolean isVariableElement(Element e)

isTypeElement

public boolean isTypeElement(Element e)

signature

public String signature(ExecutableElement e,
 TypeElement site)

Get the signature of an executable element with qualified parameter types in the context of type element site.

For instance, for a method mymethod(String x, int y), it will return (java.lang.String,int).

Parameter:

e - the executable element

site - the contextual site

Gibt zurück:

String signature with qualified parameter types

flatSignature

public String flatSignature(ExecutableElement e,
 TypeElement site)

Get the flat signature of an executable element with simple (unqualified) parameter types in the context of type element site.

For instance, for a method mymethod(String x, int y), it will return (String, int).

Parameter:

e - the executable element

site - the contextual site

Gibt zurück:

signature with simple (unqualified) parameter types

makeSignature

public String makeSignature(ExecutableElement e,
 TypeElement site,
 boolean full)

makeSignature

public String makeSignature(ExecutableElement e,
 TypeElement site,
 boolean full,
 boolean ignoreTypeParameters)

getTypeSignature

public String getTypeSignature(TypeMirror t,
 boolean qualifiedName,
 boolean noTypeParameters)

isArrayType

public boolean isArrayType(TypeMirror t)

isDeclaredType

public boolean isDeclaredType(TypeMirror t)

isTypeParameterElement

public boolean isTypeParameterElement(Element e)

isTypeVariable

public boolean isTypeVariable(TypeMirror t)

isVoid

public boolean isVoid(TypeMirror t)

ignoreBounds

public boolean ignoreBounds(TypeMirror bound)

getBounds

public List<? extends TypeMirror> getBounds(TypeParameterElement tpe)

getReturnType

public TypeMirror getReturnType(TypeElement site,
 ExecutableElement ee)

Returns the TypeMirror of the ExecutableElement if it is a method, or null if it is a constructor.

Parameter:

site - the contextual type

ee - the ExecutableElement

Gibt zurück:

the return type

asInstantiatedMethodType

public ExecutableType asInstantiatedMethodType(TypeElement site,
 ExecutableElement ee)

Returns the ExecutableType corresponding to the type of the method declaration seen as a member of a given declared type.

This might cause type-variable substitution to kick in.

Parameter:

site - the contextual type.

ee - the method declaration.

Gibt zurück:

the instantiated method type.

asInstantiatedFieldType

public TypeMirror asInstantiatedFieldType(TypeElement site,
 VariableElement ve)

Returns the TypeMirror corresponding to the type of the field declaration seen as a member of a given declared type.

This might cause type-variable substitution to kick in.

Parameter:

site - the contextual type.

ve - the field declaration.

Gibt zurück:

the instantiated field type.

overriddenMethod

public Utils.OverrideInfo overriddenMethod(ExecutableElement method)

getTypeElementsAsSortedSet

public SortedSet<TypeElement> getTypeElementsAsSortedSet(Iterable<TypeElement> typeElements)

getSerialDataTrees

public List<? extends SerialDataTree> getSerialDataTrees(ExecutableElement member)

getFileObject

public FileObject getFileObject(TypeElement te)

getDeclaredType

public TypeMirror getDeclaredType(TypeElement enclosing,
 TypeMirror target)

getDeclaredType

public TypeMirror getDeclaredType(Collection<TypeMirror> values,
 TypeElement enclosing,
 TypeMirror target)

Finds the declaration of the enclosing’s type parameter.

Parameter:

values -

enclosing - a TypeElement whose type arguments we desire

target - the TypeMirror of the type as described by the enclosing

Gibt zurück:

getAllInterfaces

public Set<TypeMirror> getAllInterfaces(TypeElement te)

Returns all the implemented superinterfaces of a given type, in the case of classes, include all the superinterfaces of the supertype.

The superinterfaces are collected before the superinterfaces of the supertype.

Parameter:

te - the type element to get the superinterfaces for.

Gibt zurück:

the list of superinterfaces.

findClassInPackageElement

public TypeElement findClassInPackageElement(PackageElement pkg,
 String className)

Lookup for a class within this package.

Gibt zurück:

TypeElement of found class, or null if not found.

isGenericType

public boolean isGenericType(TypeMirror type)

Returns true if type or any of its enclosing types has non-empty type arguments.

Parameter:

type - the type

Gibt zurück:

true if type arguments were found

findClass

public TypeElement findClass(Element element,
 String className)

TODO: FIXME: port to javax.lang.model Find a class within the context of this class.

Search order: qualified name, in this class (inner), in this package, in the class imports, in the package imports. Return the TypeElement if found, null if not found.

isDocumentedAnnotation

public boolean isDocumentedAnnotation(TypeElement annotation)

Given an annotation, return true if it should be documented and false otherwise.

Parameter:

annotation - the annotation to check.

Gibt zurück:

true return true if it should be documented and false otherwise.

isLinkable

public boolean isLinkable(TypeElement typeElem)

Returns true if this class is linkable and false if we can’t link to it.

NOTE: You can only link to external classes if they are public or protected.

Gibt zurück:

true if this class is linkable and false if we can’t link to the desired class.

isLinkable

public boolean isLinkable(TypeElement typeElem,
 Element elem)

Returns true if an element is linkable in the context of a given type element.

If the element is a type element, it delegates to isLinkable(TypeElement). Otherwise, the element is linkable if any of the following are true:

• it is "included" (see jdk.javadoc.doclet)
• it is inherited from an undocumented supertype
• it is a public or protected member of an external API

Parameter:

typeElem - the type element

elem - the element

Gibt zurück:

whether or not the element is linkable

asTypeElement

public TypeElement asTypeElement(TypeMirror t)

Return this type as a TypeElement if it represents a class interface or annotation.

Array dimensions are ignored. If this type ParameterizedType or WildcardType, return the TypeElement of the type’s erasure. If this is an annotation, return this as a TypeElement. If this is a primitive type, return null.

Gibt zurück:

the TypeElement of this type, or null if it is a primitive type.

getComponentType

public TypeMirror getComponentType(TypeMirror t)

getDimension

public String getDimension(TypeMirror t)

Return the type’s dimension information, as a string.

For example, a two dimensional array of String returns "[][]".

Gibt zurück:

the type’s dimension information as a string.

getFirstVisibleSuperClassAsTypeElement

public TypeElement getFirstVisibleSuperClassAsTypeElement(TypeElement te)

getFirstVisibleSuperClass

public TypeMirror getFirstVisibleSuperClass(TypeMirror type)

Given a class, return the closest visible superclass.

Parameter:

type - the TypeMirror to be interrogated

Gibt zurück:

the closest visible superclass. Return null if it cannot be found.

getFirstVisibleSuperClass

public TypeMirror getFirstVisibleSuperClass(TypeElement te)

Given a class, return the closest visible superclass.

Parameter:

te - the TypeElement to be interrogated

Gibt zurück:

the closest visible superclass. Return null if it cannot be found.

getTypeElementKindName

public String getTypeElementKindName(TypeElement te,
 boolean lowerCaseOnly)

Returns the name of the kind of a type element (Class, Interface, etc.).

Parameter:

te - the type element

lowerCaseOnly - true if you want the name returned in lower case; if false, the first letter of the name is capitalized

Gibt zurück:

the name

getTypeName

public String getTypeName(TypeMirror t,
 boolean fullyQualified)

replaceTabs

public String replaceTabs(String text)

Replace all tabs in a string with the appropriate number of spaces.

The string may be a multi-line string.

Parameter:

text - the text for which the tabs should be expanded

Gibt zurück:

the text with all tabs expanded

toLowerCase

public static String toLowerCase(String s)

Returns a locale independent lower cased String.

That is, it always uses US locale, this is a clone of the one in StringUtils.

Parameter:

s - to convert

Gibt zurück:

converted String

isDeprecated

public boolean isDeprecated(Element e)

Return true if the given Element is deprecated.

Parameter:

e - the Element to check.

Gibt zurück:

true if the given Element is deprecated.

isDeprecatedForRemoval

public boolean isDeprecatedForRemoval(Element e)

Returns true if the given Element is deprecated for removal.

Parameter:

e - the Element to check.

Gibt zurück:

true if the given Element is deprecated for removal.

getDeprecatedSince

public String getDeprecatedSince(Element e)

Returns the value of the Deprecated.since element if it is set on the given Element.

Parameter:

e - the Element to check.

Gibt zurück:

the Deprecated.since value for e, or null.

getPreviewFeature

public Object getPreviewFeature(Element e)

Returns the value of the internal PreviewFeature.feature element.

Parameter:

e - the Element to check

Gibt zurück:

the PreviewFeature.feature for e, or null

propertyName

public String propertyName(ExecutableElement e)

A convenience method to get property name from the name of the getter or setter method.

Parameter:

e - the input method.

Gibt zurück:

the name of the property of the given setter of getter.

hasHiddenTag

public boolean hasHiddenTag(Element e)

Returns true if the element is included or selected, contains @hidden tag, or if javafx flag is present and element contains @treatAsPrivate tag.

Parameter:

e - the queried element

Gibt zurück:

true if it exists, false otherwise

isSimpleOverride

public boolean isSimpleOverride(ExecutableElement m)

filterOutPrivateClasses

public SortedSet<TypeElement> filterOutPrivateClasses(Iterable<TypeElement> classlist,
 boolean javafx)

In case of JavaFX mode on, filters out classes that are private, package private, these are not documented in JavaFX mode, also remove those classes that have @hidden or @treatAsPrivate comment tag.

Parameter:

classlist - a collection of TypeElements

javafx - set to true if in JavaFX mode.

Gibt zurück:

list of filtered classes.

compareStrings

public int compareStrings(String s1,
 String s2)

A general purpose case insensitive String comparator, which compares two Strings using a Collator strength of “TERTIARY”.

Parameter:

s1 - first String to compare.

s2 - second String to compare.

Gibt zurück:

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

getHTMLTitle

public String getHTMLTitle(Element element)

getQualifiedTypeName

public String getQualifiedTypeName(TypeMirror t)

Get the qualified type name of a TypeMirror compatible with the Element’s getQualified name, returns the qualified name of the Reference type otherwise the primitive name.

Parameter:

t - the type whose name is to be obtained.

Gibt zurück:

the fully qualified name of Reference type or the primitive name

getFullyQualifiedName

public String getFullyQualifiedName(Element e)

A generic utility which returns the fully qualified names of an entity, if the entity is not qualifiable then its enclosing entity, it is up to the caller to add the elements name as required.

Parameter:

e - the element to get FQN for.

Gibt zurück:

the name

getFullyQualifiedName

public String getFullyQualifiedName(Element e,
 boolean outer)

getEnclosedTypeElements

public Iterable<TypeElement> getEnclosedTypeElements(PackageElement pkg)

Returns the recursively enclosed documented type elements in a package

Parameter:

pkg - the package

Gibt zurück:

the elements

getAnnotationMembers

public List<Element> getAnnotationMembers(TypeElement te)

Returns the fields and methods declared in an annotation interface.

Parameter:

te - the annotation interface

Gibt zurück:

the fields and methods

getFields

public List<VariableElement> getFields(TypeElement te)

Returns the documented fields in a type element.

Parameter:

te - the element

Gibt zurück:

the fields

getFieldsUnfiltered

public List<VariableElement> getFieldsUnfiltered(TypeElement te)

Returns the fields in a type element.

Parameter:

te - the element

Gibt zurück:

the fields

getClasses

public List<TypeElement> getClasses(Element e)

Returns the documented classes in an element, such as a package element or type element.

Parameter:

e - the element

Gibt zurück:

the classes

getConstructors

public List<ExecutableElement> getConstructors(TypeElement te)

Returns the documented constructors in a type element.

Parameter:

te - the type element

Gibt zurück:

the constructors

getMethods

public List<ExecutableElement> getMethods(TypeElement te)

Returns the documented methods in a type element.

Parameter:

te - the type element

Gibt zurück:

the methods

getModulePackageMap

public Map<ModuleElement,Set<PackageElement>> getModulePackageMap()

getDependentModules

public Map<ModuleElement,String> getDependentModules(ModuleElement mdle)

getModifiers

public String getModifiers(ModuleElement.RequiresDirective rd)

getLineNumber

public long getLineNumber(Element e)

getEnumConstants

public List<VariableElement> getEnumConstants(TypeElement te)

Returns the documented enum constants in a type element.

Parameter:

te - the element

Gibt zurück:

the interfaces

getAllClassesUnfiltered

public SortedSet<TypeElement> getAllClassesUnfiltered(PackageElement pkg)

Returns all the classes in a package.

Parameter:

pkg - the package

Gibt zurück:

the interfaces

getAllClasses

public SortedSet<TypeElement> getAllClasses(PackageElement pkg)

Returns a sorted set containing the documented classes and interfaces in a package.

Parameter:

pkg - the element

Gibt zurück:

the classes and interfaces

shouldDocument

public boolean shouldDocument(Element e)

getSimpleName

public String getSimpleName(Element e)

Returns the name of the element after the last dot of the package name.

This emulates the behavior of the old doclet.

Parameter:

e - an element whose name is required

Gibt zurück:

the name

getEnclosingTypeElement

public TypeElement getEnclosingTypeElement(Element e)

constantValueExpression

public String constantValueExpression(VariableElement ve)

isEnclosingPackageIncluded

public boolean isEnclosingPackageIncluded(TypeElement te)

isIncluded

public boolean isIncluded(Element e)

isSpecified

public boolean isSpecified(Element e)

getPackageName

public String getPackageName(PackageElement pkg)

Get the package name for a given package element.

An unnamed package is returned as <Unnamed> Use HtmlDocletWriter.getLocalizedPackageName(PackageElement) to get a localized string for the unnamed package instead.

Parameter:

pkg -

Gibt zurück:

getModuleName

public String getModuleName(ModuleElement mdle)

Get the module name for a given module element.

An unnamed module is returned as <Unnamed>

Parameter:

mdle - a ModuleElement

Gibt zurück:

getCommentHelper

public CommentHelper getCommentHelper(Element element)

removeCommentHelper

public void removeCommentHelper(Element element)

getBlockTags

public List<? extends DocTree> getBlockTags(Element element)

getBlockTags

public List<? extends DocTree> getBlockTags(DocCommentTree dcTree)

getBlockTags

public List<? extends DocTree> getBlockTags(Element element,
 Predicate<DocTree> filter)

getBlockTags

public <T extends DocTree> List<T> getBlockTags(Element element,
 Predicate<DocTree> filter,
 Class<T> tClass)

getBlockTags

public List<? extends DocTree> getBlockTags(Element element,
 DocTree.Kind kind)

getBlockTags

public <T extends DocTree> List<? extends T> getBlockTags(Element element,
 DocTree.Kind kind,
 Class<T> tClass)

getBlockTags

public List<? extends DocTree> getBlockTags(Element element,
 Taglet taglet)

hasBlockTag

public boolean hasBlockTag(Element element,
 DocTree.Kind kind)

hasBlockTag

public boolean hasBlockTag(Element element,
 DocTree.Kind kind,
 String tagName)

getTreePath

public TreePath getTreePath(Element e)

Gets a TreePath for an Element.

Note this method is called very frequently, care must be taken to ensure this method is lithe and efficient.

Parameter:

e - an Element

Gibt zurück:

TreePath

hasDocCommentTree

public boolean hasDocCommentTree(Element element)

Checks whether an element has an associated doc comment.

Parameter:

element - the element

Gibt zurück:

true if the element has a comment, and false otherwise

getDocCommentTree0

public DocCommentTree getDocCommentTree0(Element element)

Retrieves the doc comments for a given element.

Parameter:

element - the element

Gibt zurück:

DocCommentTree for the Element

checkJavaScriptInOption

public void checkJavaScriptInOption(String name,
 String value)

getDocCommentTree

public DocCommentTree getDocCommentTree(Element element)

getPreamble

public List<? extends DocTree> getPreamble(Element element)

getFullBody

public List<? extends DocTree> getFullBody(Element element)

getBody

public List<? extends DocTree> getBody(Element element)

getDeprecatedTrees

public List<? extends DeprecatedTree> getDeprecatedTrees(Element element)

getProvidesTrees

public List<? extends ProvidesTree> getProvidesTrees(Element element)

getSeeTrees

public List<? extends SeeTree> getSeeTrees(Element element)

getSerialTrees

public List<? extends SerialTree> getSerialTrees(Element element)

getSerialFieldTrees

public List<? extends SerialFieldTree> getSerialFieldTrees(VariableElement field)

getSpecTrees

public List<? extends SpecTree> getSpecTrees(Element element)

getThrowsTrees

public List<ThrowsTree> getThrowsTrees(Element element)

getTypeParamTrees

public List<ParamTree> getTypeParamTrees(Element element)

getParamTrees

public List<ParamTree> getParamTrees(Element element)

getReturnTrees

public List<? extends ReturnTree> getReturnTrees(Element element)

getUsesTrees

public List<? extends UsesTree> getUsesTrees(Element element)

getFirstSentenceTrees

public List<? extends DocTree> getFirstSentenceTrees(Element element)

containingModule

public ModuleElement containingModule(Element e)

containingPackage

public PackageElement containingPackage(Element e)

previewLanguageFeaturesUsed

public Set<Utils.DeclarationPreviewLanguageFeatures> previewLanguageFeaturesUsed(Element e)

Return the set of preview language features used to declare the given element.

Parameter:

e - the Element to check.

Gibt zurück:

the set of preview language features used to declare the given element

declaredUsingPreviewAPIs

public Utils.PreviewSummary declaredUsingPreviewAPIs(Element el)

isPreviewAPI

public boolean isPreviewAPI(Element el)

Checks whether the given Element should be marked as a preview API.

Note that if a type is marked as a preview, its members are not.

Parameter:

el - the element to check

Gibt zurück:

true if and only if the given element should be marked as a preview API

isReflectivePreviewAPI

public boolean isReflectivePreviewAPI(Element el)

Checks whether the given Element should be marked as a reflective preview API.

Note that if a type is marked as a preview, its members are not.

Parameter:

el - the element to check

Gibt zurück:

true if and only if the given element should be marked as a reflective preview API

elementFlags

public Set<Utils.ElementFlag> elementFlags(Element el)

Return all flags for the given Element.

Parameter:

el - the element to test

Gibt zurück:

the set of all the element’s flags.

setPreviewFlagProvider

public Utils.PreviewFlagProvider setPreviewFlagProvider(Utils.PreviewFlagProvider provider)

docFinder

public DocFinder docFinder()