JSDocInfo (Closure Compiler v20170124 API)

java.lang.Object
- com.google.javascript.rhino.JSDocInfo

All Implemented Interfaces:

Serializable
```
public class JSDocInfo
extends Object
implements Serializable
```
JSDoc information describing JavaScript code. JSDoc is represented as a unified object with fields for each JSDoc annotation, even though some combinations are incorrect. For instance, if a JSDoc describes an enum, it cannot have information about a return type. This implementation takes advantage of such incompatibilities to reuse fields for multiple purposes, reducing memory consumption.

Constructing JSDocInfo objects is simplified by JSDocInfoBuilder which provides early incompatibility detection.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JSDocInfo.Marker` Defines a class for containing the parsing information for this JSDocInfo.
`static class`	`JSDocInfo.NamePosition` A piece of information (found in a marker) which contains a position with a name node.
`static class`	`JSDocInfo.StringPosition` A piece of information (found in a marker) which contains a position with a string.
`static class`	`JSDocInfo.TypePosition` A piece of information (found in a marker) which contains a position with a type expression syntax tree.
`static class`	`JSDocInfo.Visibility` Visibility categories.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`areEquivalent(JSDocInfo jsDoc1, JSDocInfo jsDoc2)`
`JSDocInfo`	`clone()`
`JSDocInfo`	`clone(boolean cloneTypeNodes)`
`boolean`	`containsDeclaration()`
`boolean`	`containsFunctionDeclaration()`
`boolean`	`containsTypeDefinition()`
`boolean`	`disposesOf(String parameterName)` Return whether the function disposes of specified parameter.
`Collection<String>`	`getAuthors()` Returns the list of authors or null if none.
`JSTypeExpression`	`getBaseType()` Gets the base type specified by the `@extends` annotation.
`String`	`getBlockDescription()` Returns the block-level description or null if none specified.
`String`	`getDeprecationReason()` Returns the deprecation reason or null if none specified.
`String`	`getDescription()` Gets the description specified by the `@desc` annotation.
`String`	`getDescriptionForParameter(String name)` Returns the description for the parameter with the given name, if its exists.
`JSTypeExpression`	`getEnumParameterType()` Gets the enum parameter type specified by the `@enum` annotation.
`List<JSTypeExpression>`	`getExtendedInterfaces()` Returns the interfaces extended by an interface
`int`	`getExtendedInterfacesCount()` Gets the number of extended interfaces specified
`String`	`getFileOverview()` Returns the file overview or null if none specified.
`int`	`getImplementedInterfaceCount()` Gets the number of interfaces specified by the `@implements` annotation.
`List<JSTypeExpression>`	`getImplementedInterfaces()` Returns the types specified by the `@implements` annotation.
`String`	`getLendsName()` Gets the name we're lending to in a `@lends` annotation.
`String`	`getLicense()` Gets the description specified by the `@license` annotation.
`Collection<JSDocInfo.Marker>`	`getMarkers()` Gets the list of all markers for the documentation in this JSDoc.
`String`	`getMeaning()` Gets the meaning specified by the `@meaning` annotation.
`Set<String>`	`getModifies()` Returns the set of sideeffect notations.
`int`	`getOriginalCommentPosition()`
`String`	`getOriginalCommentString()` Returns the original JSDoc comment string.
`int`	`getParameterCount()` Gets the number of parameters defined.
`String`	`getParameterNameAt(int index)` Returns the nth name in the defined parameters.
`Set<String>`	`getParameterNames()` Returns the set of names of the defined parameters.
`JSTypeExpression`	`getParameterType(String parameter)` Gets the type of a given named parameter.
`Collection<String>`	`getReferences()` Returns the list of references or null if none.
`String`	`getReturnDescription()` Returns the description of the returned object or null if none specified.
`JSTypeExpression`	`getReturnType()` Gets the return type specified by the `@return` annotation.
`Set<String>`	`getSuppressions()` Returns the set of suppressed warnings.
`com.google.common.collect.ImmutableList<String>`	`getTemplateTypeNames()` Gets the template type name.
`JSTypeExpression`	`getThisType()` Gets the type specified by the `@this` annotation.
`List<JSTypeExpression>`	`getThrownTypes()` Returns the list of thrown types.
`String`	`getThrowsDescriptionForType(JSTypeExpression type)` Get the message for a given thrown type.
`JSTypeExpression`	`getType()` Gets the type specified by the `@type` annotation.
`JSTypeExpression`	`getTypedefType()` Gets the typedef type specified by the `@type` annotation.
`Collection<Node>`	`getTypeNodes()` Returns a collection of all type nodes that are a part of this JSDocInfo.
`com.google.common.collect.ImmutableMap<String,Node>`	`getTypeTransformations()` Gets the type transformations.
`String`	`getVersion()` Returns the version or null if none.
`JSDocInfo.Visibility`	`getVisibility()` Gets the visibility specified by `@private`, `@protected` or `@public` annotation.
`boolean`	`hasBaseType()` Returns whether this `JSDocInfo` contains a type for `@extends` annotation.
`boolean`	`hasConstAnnotation()` Returns whether the `@const` annotation is present on this `JSDocInfo`.
`boolean`	`hasDescriptionForParameter(String name)` Returns whether a description exists for the parameter with the specified name.
`boolean`	`hasEnumParameterType()` Returns whether an enum parameter type, specified using the `@enum` annotation, is present on this JSDoc.
`boolean`	`hasFileOverview()` Returns whether this has a fileoverview flag.
`boolean`	`hasModifies()`
`boolean`	`hasParameter(String parameter)` Returns whether the parameter is defined.
`boolean`	`hasParameterType(String parameter)` Returns whether the parameter has an attached type.
`boolean`	`hasReturnType()` Returns whether this `JSDocInfo` contains a type for `@return` annotation.
`boolean`	`hasSideEffectsArgumentsAnnotation()`
`boolean`	`hasThisType()` Returns whether this `JSDocInfo` contains a type for `@this` annotation.
`boolean`	`hasType()` Returns whether a type, specified using the `@type` annotation, is present on this JSDoc.
`boolean`	`hasTypedefType()` Returns whether a typedef parameter type, specified using the `@typedef` annotation, is present on this JSDoc.
`boolean`	`hasTypeInformation()`
`boolean`	`isAbstract()` Returns whether the `@abstract` annotation is present on this `JSDocInfo`.
`boolean`	`isConsistentIdGenerator()`
`boolean`	`isConstant()`
`boolean`	`isConstructor()` Returns whether the `@constructor` annotation is present on this `JSDocInfo`.
`boolean`	`isConstructorOrInterface()`
`boolean`	`isDefine()` Returns whether the `@define` annotation is present on this `JSDocInfo`.
`boolean`	`isDeprecated()` Returns whether the `@deprecated` annotation is present on this `JSDocInfo`.
`boolean`	`isDisposes()` Returns whether JSDoc is annotated with `@disposes` annotation.
`boolean`	`isExport()` Returns whether the `@export` annotation is present on this `JSDocInfo`.
`boolean`	`isExpose()` Returns whether the `@expose` annotation is present on this `JSDocInfo`.
`boolean`	`isExterns()` Returns whether the `@externs` annotation is present on this `JSDocInfo`.
`boolean`	`isFinal()` Returns whether the `@final` annotation is present on this `JSDocInfo`.
`boolean`	`isHidden()` Returns whether the `@hidden` annotation is present on this `JSDocInfo`.
`boolean`	`isIdGenerator()`
`boolean`	`isImplicitCast()` Returns whether the `@implicitCast` annotation is present on this `JSDocInfo`.
`boolean`	`isInlineType()` Returns whether the type annotation was inlined.
`boolean`	`isInterface()` Returns whether the `@interface` annotation is present on this `JSDocInfo`.
`boolean`	`isJaggerInject()` Returns whether JSDoc is annotated with `@jaggerInject` annotation.
`boolean`	`isJaggerModule()` Returns whether JSDoc is annotated with `@jaggerModule` annotation.
`boolean`	`isJaggerProvide()` Returns whether JSDoc is annotated with `@jaggerProvidePromise` annotation.
`boolean`	`isJaggerProvidePromise()` Returns whether JSDoc is annotated with `@jaggerProvidePromise` annotation.
`boolean`	`isMappedIdGenerator()`
`boolean`	`isNgInject()` Returns whether JSDoc is annotated with `@ngInject` annotation.
`boolean`	`isNoAlias()` Returns whether the `@noalias` annotation is present on this `JSDocInfo`.
`boolean`	`isNoCollapse()` Returns whether the `@nocompile` annotation is present on this `JSDocInfo`.
`boolean`	`isNoCompile()` Returns whether the `@nocompile` annotation is present on this `JSDocInfo`.
`boolean`	`isNoSideEffects()` Returns whether the `@nosideeffects` annotation is present on this `JSDocInfo`.
`boolean`	`isOverride()` Returns whether the `@override` annotation is present on this `JSDocInfo`.
`boolean`	`isPolymerBehavior()` Returns whether JSDoc is annotated with `@polymerBehavior` annotation.
`boolean`	`isStableIdGenerator()`
`boolean`	`isWizaction()` Returns whether JSDoc is annotated with `@wizaction` annotation.
`boolean`	`isXidGenerator()`
`boolean`	`makesDicts()` Returns whether the `@dict` annotation is present on this `JSDocInfo`.
`boolean`	`makesStructs()` Returns whether the `@struct` annotation is present on this `JSDocInfo`.
`boolean`	`makesUnrestricted()` Returns whether the `@unrestricted` annotation is present on this `JSDocInfo`.
`boolean`	`modifiesThis()` Get the value of the @modifies{this} annotation stored in the doc info.
`String`	`toString()`
`String`	`toStringVerbose()`
`boolean`	`usesImplicitMatch()` Returns whether the `@record` annotation is present on this `JSDocInfo`.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - clone
```
public JSDocInfo clone()
```
    Overrides:
    
    clone in class Object
  - clone
```
public JSDocInfo clone(boolean cloneTypeNodes)
```
  - areEquivalent
```
public static boolean areEquivalent(JSDocInfo jsDoc1,
                                    JSDocInfo jsDoc2)
```
  - isConsistentIdGenerator
```
public boolean isConsistentIdGenerator()
```
    Returns:
    
    whether the @consistentIdGenerator is present on this JSDocInfo
  - isStableIdGenerator
```
public boolean isStableIdGenerator()
```
    Returns:
    
    whether the @stableIdGenerator is present on this JSDocInfo.
  - isXidGenerator
```
public boolean isXidGenerator()
```
    Returns:
    
    whether the @idGenerator {xid} is present on this JSDocInfo.
  - isMappedIdGenerator
```
public boolean isMappedIdGenerator()
```
    Returns:
    
    whether the @idGenerator {mapped} is present on this JSDocInfo.
  - isConstant
```
public boolean isConstant()
```
  - hasConstAnnotation
```
public boolean hasConstAnnotation()
```
    Returns whether the @const annotation is present on this JSDocInfo.
  - isFinal
```
public boolean isFinal()
```
    Returns whether the @final annotation is present on this JSDocInfo.
  - isConstructor
```
public boolean isConstructor()
```
    Returns whether the @constructor annotation is present on this JSDocInfo.
  - isAbstract
```
public boolean isAbstract()
```
    Returns whether the @abstract annotation is present on this JSDocInfo.
  - usesImplicitMatch
```
public boolean usesImplicitMatch()
```
    Returns whether the @record annotation is present on this JSDocInfo.
  - makesUnrestricted
```
public boolean makesUnrestricted()
```
    Returns whether the @unrestricted annotation is present on this JSDocInfo.
  - makesStructs
```
public boolean makesStructs()
```
    Returns whether the @struct annotation is present on this JSDocInfo.
  - makesDicts
```
public boolean makesDicts()
```
    Returns whether the @dict annotation is present on this JSDocInfo.
  - isDefine
```
public boolean isDefine()
```
    Returns whether the @define annotation is present on this JSDocInfo. If this annotation is present, then the getType() method will retrieve the define type.
  - isHidden
```
public boolean isHidden()
```
    Returns whether the @hidden annotation is present on this JSDocInfo.
  - isOverride
```
public boolean isOverride()
```
    Returns whether the @override annotation is present on this JSDocInfo.
  - isNoAlias
```
public boolean isNoAlias()
```
    Returns whether the @noalias annotation is present on this JSDocInfo.
  - isDeprecated
```
public boolean isDeprecated()
```
    Returns whether the @deprecated annotation is present on this JSDocInfo.
  - isInterface
```
public boolean isInterface()
```
    Returns whether the @interface annotation is present on this JSDocInfo.
  - isConstructorOrInterface
```
public boolean isConstructorOrInterface()
```
  - isExport
```
public boolean isExport()
```
    Returns whether the @export annotation is present on this JSDocInfo.
  - isExpose
```
public boolean isExpose()
```
    Returns whether the @expose annotation is present on this JSDocInfo.
  - isIdGenerator
```
public boolean isIdGenerator()
```
    Returns:
    
    whether the @idGenerator is present on this JSDocInfo
  - isImplicitCast
```
public boolean isImplicitCast()
```
    Returns whether the @implicitCast annotation is present on this JSDocInfo.
  - isNoSideEffects
```
public boolean isNoSideEffects()
```
    Returns whether the @nosideeffects annotation is present on this JSDocInfo.
  - isExterns
```
public boolean isExterns()
```
    Returns whether the @externs annotation is present on this JSDocInfo.
  - isNoCompile
```
public boolean isNoCompile()
```
    Returns whether the @nocompile annotation is present on this JSDocInfo.
  - isNoCollapse
```
public boolean isNoCollapse()
```
    Returns whether the @nocompile annotation is present on this JSDocInfo.
  - containsDeclaration
```
public boolean containsDeclaration()
```
    Returns:
    
    Whether there is a declaration present on this JSDocInfo.
  - containsFunctionDeclaration
```
public boolean containsFunctionDeclaration()
```
    Returns:
    
    Whether there is a declaration of a callable type.
  - containsTypeDefinition
```
public boolean containsTypeDefinition()
```
  - getVisibility
```
public JSDocInfo.Visibility getVisibility()
```
    Gets the visibility specified by @private, @protected or @public annotation. If no visibility is specified, visibility is inherited from the base class.
  - getParameterType
```
public JSTypeExpression getParameterType(String parameter)
```
    Gets the type of a given named parameter.
    
    Parameters:
    
    parameter - the parameter's name
    
    Returns:
    
    the parameter's type or null if this parameter is not defined or has a null type
  - hasParameter
```
public boolean hasParameter(String parameter)
```
    Returns whether the parameter is defined.
  - hasParameterType
```
public boolean hasParameterType(String parameter)
```
    Returns whether the parameter has an attached type.
    
    Returns:
    
    true if the parameter has an attached type, false if the parameter has no attached type or does not exist.
  - getParameterNames
```
public Set<String> getParameterNames()
```
    Returns the set of names of the defined parameters. The iteration order of the returned set is the order in which parameters are defined in the JSDoc, rather than the order in which the function declares them.
    
    Returns:
    
    the set of names of the defined parameters. The returned set is immutable.
  - getParameterNameAt
```
public String getParameterNameAt(int index)
```
    Returns the nth name in the defined parameters. The iteration order is the order in which parameters are defined in the JSDoc, rather than the order in which the function declares them.
  - getParameterCount
```
public int getParameterCount()
```
    Gets the number of parameters defined.
  - getThrownTypes
```
public List<JSTypeExpression> getThrownTypes()
```
    Returns the list of thrown types.
  - getThrowsDescriptionForType
```
public String getThrowsDescriptionForType(JSTypeExpression type)
```
    Get the message for a given thrown type.
  - hasType
```
public boolean hasType()
```
    Returns whether a type, specified using the @type annotation, is present on this JSDoc.
  - hasEnumParameterType
```
public boolean hasEnumParameterType()
```
    Returns whether an enum parameter type, specified using the @enum annotation, is present on this JSDoc.
  - hasTypedefType
```
public boolean hasTypedefType()
```
    Returns whether a typedef parameter type, specified using the @typedef annotation, is present on this JSDoc.
  - hasReturnType
```
public boolean hasReturnType()
```
    Returns whether this JSDocInfo contains a type for @return annotation.
  - hasTypeInformation
```
public boolean hasTypeInformation()
```
  - getType
```
public JSTypeExpression getType()
```
    Gets the type specified by the @type annotation.
  - isInlineType
```
public boolean isInlineType()
```
    Returns whether the type annotation was inlined.
  - getReturnType
```
public JSTypeExpression getReturnType()
```
    Gets the return type specified by the @return annotation.
  - getEnumParameterType
```
public JSTypeExpression getEnumParameterType()
```
    Gets the enum parameter type specified by the @enum annotation.
  - getTypedefType
```
public JSTypeExpression getTypedefType()
```
    Gets the typedef type specified by the @type annotation.
  - getThisType
```
public JSTypeExpression getThisType()
```
    Gets the type specified by the @this annotation.
  - hasThisType
```
public boolean hasThisType()
```
    Returns whether this JSDocInfo contains a type for @this annotation.
  - getBaseType
```
public JSTypeExpression getBaseType()
```
    Gets the base type specified by the @extends annotation.
  - getDescription
```
public String getDescription()
```
    Gets the description specified by the @desc annotation.
  - getMeaning
```
public String getMeaning()
```
    Gets the meaning specified by the @meaning annotation.
    In localization systems, two messages with the same content but different "meanings" may be translated differently. By default, we use the name of the variable that the message is initialized to as the "meaning" of the message.
    But some code generators (like Closure Templates) inject their own meaning with the jsdoc @meaning annotation.
  - getLendsName
```
public String getLendsName()
```
    Gets the name we're lending to in a @lends annotation.
    In many reflection APIs, you pass an anonymous object to a function, and that function mixes the anonymous object into another object. The @lends annotation allows the type system to track those property assignments.
  - isNgInject
```
public boolean isNgInject()
```
    Returns whether JSDoc is annotated with @ngInject annotation.
  - isJaggerInject
```
public boolean isJaggerInject()
```
    Returns whether JSDoc is annotated with @jaggerInject annotation.
  - isJaggerProvide
```
public boolean isJaggerProvide()
```
    Returns whether JSDoc is annotated with @jaggerProvidePromise annotation.
  - isJaggerProvidePromise
```
public boolean isJaggerProvidePromise()
```
    Returns whether JSDoc is annotated with @jaggerProvidePromise annotation.
  - isJaggerModule
```
public boolean isJaggerModule()
```
    Returns whether JSDoc is annotated with @jaggerModule annotation.
  - isWizaction
```
public boolean isWizaction()
```
    Returns whether JSDoc is annotated with @wizaction annotation.
  - isPolymerBehavior
```
public boolean isPolymerBehavior()
```
    Returns whether JSDoc is annotated with @polymerBehavior annotation.
  - isDisposes
```
public boolean isDisposes()
```
    Returns whether JSDoc is annotated with @disposes annotation.
  - disposesOf
```
public boolean disposesOf(String parameterName)
```
    Return whether the function disposes of specified parameter.
  - getLicense
```
public String getLicense()
```
    Gets the description specified by the @license annotation.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toStringVerbose
```
public String toStringVerbose()
```
  - hasBaseType
```
public boolean hasBaseType()
```
    Returns whether this JSDocInfo contains a type for @extends annotation.
  - getImplementedInterfaces
```
public List<JSTypeExpression> getImplementedInterfaces()
```
    Returns the types specified by the @implements annotation.
    
    Returns:
    
    An immutable list of JSTypeExpression objects that can be resolved to types.
  - getImplementedInterfaceCount
```
public int getImplementedInterfaceCount()
```
    Gets the number of interfaces specified by the @implements annotation.
  - getExtendedInterfaces
```
public List<JSTypeExpression> getExtendedInterfaces()
```
    Returns the interfaces extended by an interface
    
    Returns:
    
    An immutable list of JSTypeExpression objects that can be resolved to types.
  - getExtendedInterfacesCount
```
public int getExtendedInterfacesCount()
```
    Gets the number of extended interfaces specified
  - getDeprecationReason
```
public String getDeprecationReason()
```
    Returns the deprecation reason or null if none specified.
  - getSuppressions
```
public Set<String> getSuppressions()
```
    Returns the set of suppressed warnings.
  - getModifies
```
public Set<String> getModifies()
```
    Returns the set of sideeffect notations.
  - hasDescriptionForParameter
```
public boolean hasDescriptionForParameter(String name)
```
    Returns whether a description exists for the parameter with the specified name.
  - getDescriptionForParameter
```
public String getDescriptionForParameter(String name)
```
    Returns the description for the parameter with the given name, if its exists.
  - getAuthors
```
public Collection<String> getAuthors()
```
    Returns the list of authors or null if none.
  - getReferences
```
public Collection<String> getReferences()
```
    Returns the list of references or null if none.
  - getVersion
```
public String getVersion()
```
    Returns the version or null if none.
  - getReturnDescription
```
public String getReturnDescription()
```
    Returns the description of the returned object or null if none specified.
  - getBlockDescription
```
public String getBlockDescription()
```
    Returns the block-level description or null if none specified.
  - hasFileOverview
```
public boolean hasFileOverview()
```
    Returns whether this has a fileoverview flag.
  - getFileOverview
```
public String getFileOverview()
```
    Returns the file overview or null if none specified.
  - getMarkers
```
public Collection<JSDocInfo.Marker> getMarkers()
```
    Gets the list of all markers for the documentation in this JSDoc.
  - getTemplateTypeNames
```
public com.google.common.collect.ImmutableList<String> getTemplateTypeNames()
```
    Gets the template type name.
  - getTypeTransformations
```
public com.google.common.collect.ImmutableMap<String,Node> getTypeTransformations()
```
    Gets the type transformations.
  - getTypeNodes
```
public Collection<Node> getTypeNodes()
```
    Returns a collection of all type nodes that are a part of this JSDocInfo. This includes @type, @this, @extends, @implements, @param, @throws, and @return. Any future type specific JSDoc should make sure to add the appropriate nodes here.
    
    Returns:
    
    collection of all type nodes
  - hasModifies
```
public boolean hasModifies()
```
  - getOriginalCommentString
```
public String getOriginalCommentString()
```
    Returns the original JSDoc comment string. Returns null unless parseJsDocDocumentation is enabled via the ParserConfig.
  - getOriginalCommentPosition
```
public int getOriginalCommentPosition()
```
  - modifiesThis
```
public boolean modifiesThis()
```
    Get the value of the @modifies{this} annotation stored in the doc info.
  - hasSideEffectsArgumentsAnnotation
```
public boolean hasSideEffectsArgumentsAnnotation()
```
    Returns:
    
    Whether the @modifies annotation includes "arguments" or any named parameters.

Class JSDocInfo

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

clone

clone

areEquivalent

isConsistentIdGenerator

isStableIdGenerator

isXidGenerator

isMappedIdGenerator

isConstant

hasConstAnnotation

isFinal

isConstructor

isAbstract

usesImplicitMatch

makesUnrestricted

makesStructs

makesDicts

isDefine

isHidden

isOverride

isNoAlias

isDeprecated

isInterface

isConstructorOrInterface

isExport

isExpose

isIdGenerator

isImplicitCast

isNoSideEffects

isExterns

isNoCompile

isNoCollapse

containsDeclaration

containsFunctionDeclaration

containsTypeDefinition

getVisibility

getParameterType

hasParameter

hasParameterType

getParameterNames

getParameterNameAt

getParameterCount

getThrownTypes

getThrowsDescriptionForType

hasType

hasEnumParameterType

hasTypedefType

hasReturnType

hasTypeInformation

getType

isInlineType

getReturnType

getEnumParameterType

getTypedefType

getThisType

hasThisType

getBaseType

getDescription

getMeaning

getLendsName

isNgInject

isJaggerInject

isJaggerProvide

isJaggerProvidePromise

isJaggerModule

isWizaction

isPolymerBehavior

isDisposes

disposesOf

getLicense

toString

toStringVerbose

hasBaseType

getImplementedInterfaces

getImplementedInterfaceCount

getExtendedInterfaces