Package com.google.javascript.rhino
Class JSDocInfoBuilder
java.lang.Object
com.google.javascript.rhino.JSDocInfoBuilder
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Adds an author to the current information.boolean
addReference
(String reference) Adds a reference ("@see") to the current information.Builds aJSDocInfo
object based on the populated information and returns it.boolean
hasParameter
(String name) boolean
boolean
Returns whether this builder recorded a description.boolean
boolean
boolean
Returns whether current JSDoc is annotated with@ngInject
.boolean
Returns whether this builder is populated with information that can be used tobuild(com.google.javascript.rhino.Node)
aJSDocInfo
object.boolean
Returns whether this builder is populated with information that can be used tobuild(com.google.javascript.rhino.Node)
aJSDocInfo
object that has a fileoverview tag.void
markAnnotation
(String annotation, int lineno, int charno) Adds a marker to the current JSDocInfo and populates the marker with the annotation information.void
Deprecated.Use #markName(String, StaticSourceFile, int, int)void
markName
(String name, StaticSourceFile file, int lineno, int charno) Adds a name declaration to the current marker.void
Adds a textual block to the current marker.void
markTypeNode
(Node typeNode, int lineno, int startCharno, int endLineno, int endCharno, boolean hasLC) Adds a type declaration to the current marker.boolean
recordBaseType
(JSTypeExpression jsType) Records a base type.boolean
recordBlockDescription
(String description) Records a block-level description.boolean
recordClassTemplateTypeNames
(List<String> names) Records a template type name.boolean
Records that theJSDocInfo
being built should have itsJSDocInfo.isConsistentIdGenerator()
flag set totrue
.boolean
boolean
boolean
Records the type of a define.boolean
boolean
recordDeprecationReason
(String reason) Records the deprecation reason.boolean
recordDescription
(String description) Records a description giving context for translation (i18n).boolean
boolean
Records a parameter type to an enum.boolean
boolean
boolean
recordExtendedInterface
(JSTypeExpression interfaceType) Records an extended interface type.boolean
boolean
recordFileOverview
(String description) Records a fileoverview description.boolean
boolean
boolean
recordImplementedInterface
(JSTypeExpression interfaceName) Records an implemented interface.boolean
boolean
boolean
boolean
recordLends
(String name) Records that we're lending to another name.boolean
recordMeaning
(String meaning) Records a meaning giving context for translation (i18n).boolean
recordModifies
(Set<String> modifies) Records the list of modifies warnings.boolean
recordNgInject
(boolean ngInject) Records that we'd like to add$inject
property inferred from parameters.boolean
boolean
boolean
boolean
Records that theJSDocInfo
being built should have itsJSDocInfo.isNoSideEffects()
flag set totrue
.boolean
void
recordOriginalCommentString
(String sourceComment) Sets the original JSDoc comment string.boolean
boolean
recordParameter
(String parameterName, JSTypeExpression type) Records a typed parameter.boolean
recordParameterDescription
(String parameterName, String description) Records a parameter's description.boolean
Records that theJSDocInfo
being built should have itsJSDocInfo.shouldPreserveTry()
flag set totrue
.boolean
recordReturnDescription
(String description) Records a return descriptionboolean
recordReturnType
(JSTypeExpression jsType) Records a return type.boolean
Records that theJSDocInfo
being built should have itsJSDocInfo.isStableIdGenerator()
flag set totrue
.boolean
boolean
recordSuppressions
(Set<String> suppressions) Records the list of suppressed warnings.boolean
recordTemplateTypeNames
(List<String> names) Records a template type name.boolean
Records a type for@this
annotation.boolean
recordThrowDescription
(JSTypeExpression type, String description) Records a throw type's description.boolean
Records a thrown type.boolean
recordType
(JSTypeExpression type) Records a type.boolean
Records that theJSDocInfo
being built should be populated with atypedef
'd type.boolean
recordVersion
(String version) Records the version.boolean
recordVisibility
(JSDocInfo.Visibility visibility) Records a visibility.boolean
-
Constructor Details
-
JSDocInfoBuilder
public JSDocInfoBuilder(boolean parseDocumentation)
-
-
Method Details
-
recordOriginalCommentString
Sets the original JSDoc comment string. This is a no-op if the builder isn't configured to record documentation. -
shouldParseDocumentation
public boolean shouldParseDocumentation() -
isPopulated
public boolean isPopulated()Returns whether this builder is populated with information that can be used tobuild(com.google.javascript.rhino.Node)
aJSDocInfo
object. -
isPopulatedWithFileOverview
public boolean isPopulatedWithFileOverview()Returns whether this builder is populated with information that can be used tobuild(com.google.javascript.rhino.Node)
aJSDocInfo
object that has a fileoverview tag. -
isDescriptionRecorded
public boolean isDescriptionRecorded()Returns whether this builder recorded a description. -
build
Builds aJSDocInfo
object based on the populated information and returns it. Once this method is called, the builder can be reused to build anotherJSDocInfo
object.- Parameters:
associatedNode
- The source node containing the JSDoc.- Returns:
- a
JSDocInfo
object populated with the values given to this builder. If no value was populated, this method simply returnsnull
-
markAnnotation
Adds a marker to the current JSDocInfo and populates the marker with the annotation information. -
markText
Adds a textual block to the current marker. -
markTypeNode
public void markTypeNode(Node typeNode, int lineno, int startCharno, int endLineno, int endCharno, boolean hasLC) Adds a type declaration to the current marker. -
markName
Deprecated.Use #markName(String, StaticSourceFile, int, int)Adds a name declaration to the current marker. -
markName
Adds a name declaration to the current marker. -
recordBlockDescription
Records a block-level description.- Returns:
true
if the description was recorded.
-
recordVisibility
Records a visibility.- Returns:
true
if the visibility was recorded andfalse
if it was already defined
-
recordParameter
Records a typed parameter.- Returns:
true
if the typed parameter was recorded andfalse
if a parameter with the same name was already defined
-
recordParameterDescription
Records a parameter's description.- Returns:
true
if the parameter's description was recorded andfalse
if a parameter with the same name was already defined
-
recordTemplateTypeNames
Records a template type name.- Returns:
true
if the template type name was recorded andfalse
if a template type name was already defined.
-
recordClassTemplateTypeNames
Records a template type name.- Returns:
true
if the template type name was recorded andfalse
if a template type name was already defined.
-
recordThrowType
Records a thrown type. -
recordThrowDescription
Records a throw type's description.- Returns:
true
if the type's description was recorded andfalse
if a description with the same type was already defined
-
addAuthor
Adds an author to the current information. -
addReference
Adds a reference ("@see") to the current information. -
recordConsistentIdGenerator
public boolean recordConsistentIdGenerator()Records that theJSDocInfo
being built should have itsJSDocInfo.isConsistentIdGenerator()
flag set totrue
.- Returns:
true
if the consistentIdGenerator flag was recorded andfalse
if it was already recorded
-
recordStableIdGenerator
public boolean recordStableIdGenerator()Records that theJSDocInfo
being built should have itsJSDocInfo.isStableIdGenerator()
flag set totrue
.- Returns:
true
if the stableIdGenerator flag was recorded andfalse
if it was already recorded.
-
recordVersion
Records the version. -
recordDeprecationReason
Records the deprecation reason. -
recordSuppressions
Records the list of suppressed warnings. -
recordModifies
Records the list of modifies warnings. -
recordType
Records a type.- Returns:
true
if the type was recorded andfalse
if it is invalid or was already defined
-
recordTypedef
Records that theJSDocInfo
being built should be populated with atypedef
'd type. -
recordIdGenerator
public boolean recordIdGenerator()- Returns:
true
if the idGenerator flag was recorded andfalse
if it was already recorded
-
recordReturnType
Records a return type.- Returns:
true
if the return type was recorded andfalse
if it is invalid or was already defined
-
recordReturnDescription
Records a return description- Returns:
true
if the return description was recorded andfalse
if it is invalid or was already defined
-
recordDefineType
Records the type of a define. 'Define' values are special constants that may be manipulated by the compiler. They are designed to mimic the #define command in the C preprocessor. -
recordEnumParameterType
Records a parameter type to an enum.- Returns:
true
if the enum's parameter type was recorded andfalse
if it was invalid or already defined
-
recordThisType
Records a type for@this
annotation.- Returns:
true
if the type was recorded andfalse
if it is invalid or if it collided with@enum
or@type
annotations
-
recordBaseType
Records a base type.- Returns:
true
if the base type was recorded andfalse
if it was already defined
-
recordConstancy
public boolean recordConstancy()- Returns:
true
if the constancy was recorded andfalse
if it was already defined
-
recordDescription
Records a description giving context for translation (i18n).- Returns:
true
if the description was recorded andfalse
if the description was invalid or was already defined
-
recordMeaning
Records a meaning giving context for translation (i18n). Different meanings will result in different translations.- Returns:
true
If the meaning was successfully updated.
-
recordFileOverview
Records a fileoverview description.- Returns:
true
if the description was recorded andfalse
if the description was invalid or was already defined.
-
recordHiddenness
public boolean recordHiddenness()- Returns:
true
if the hiddenness was recorded andfalse
if it was already defined
-
recordNoCompile
public boolean recordNoCompile()- Returns:
true
if the no compile flag was recorded andfalse
if it was already recorded
-
recordNoTypeCheck
public boolean recordNoTypeCheck()- Returns:
true
if the no check flag was recorded andfalse
if it was already recorded
-
recordConstructor
public boolean recordConstructor()- Returns:
true
if the constructor was recorded andfalse
if it was already defined or it was incompatible with the existing flags
-
isConstructorRecorded
public boolean isConstructorRecorded() -
recordStruct
public boolean recordStruct()- Returns:
true
if the struct was recorded andfalse
if it was already defined or it was incompatible with the existing flags
-
recordDict
public boolean recordDict()- Returns:
true
if the dict was recorded andfalse
if it was already defined or it was incompatible with the existing flags
-
recordJavaDispatch
public boolean recordJavaDispatch()- Returns:
true
if the javadispatch was recorded andfalse
if it was already defined or it was incompatible with the existing flags
-
isJavaDispatch
public boolean isJavaDispatch() -
recordPreserveTry
public boolean recordPreserveTry()Records that theJSDocInfo
being built should have itsJSDocInfo.shouldPreserveTry()
flag set totrue
. -
recordOverride
public boolean recordOverride() -
recordNoAlias
public boolean recordNoAlias() -
recordDeprecated
public boolean recordDeprecated() -
recordInterface
public boolean recordInterface()- Returns:
true
if the flag was recorded andfalse
if it was already defined or it was incompatible with the existing flags
-
recordExport
public boolean recordExport() -
recordExpose
public boolean recordExpose() -
recordNoShadow
public boolean recordNoShadow() -
recordImplicitCast
public boolean recordImplicitCast() -
recordNoSideEffects
public boolean recordNoSideEffects()Records that theJSDocInfo
being built should have itsJSDocInfo.isNoSideEffects()
flag set totrue
. -
recordExterns
public boolean recordExterns() -
isInterfaceRecorded
public boolean isInterfaceRecorded() -
hasParameter
- Returns:
- Whether a parameter of the given name has already been recorded.
-
recordImplementedInterface
Records an implemented interface. -
recordExtendedInterface
Records an extended interface type. -
recordLends
Records that we're lending to another name. -
isNgInjectRecorded
public boolean isNgInjectRecorded()Returns whether current JSDoc is annotated with@ngInject
. -
recordNgInject
public boolean recordNgInject(boolean ngInject) Records that we'd like to add$inject
property inferred from parameters.
-