com.google.javascript.jscomp.modules

Class ModuleMetadataMap.ModuleMetadata

java.lang.Object

com.google.javascript.jscomp.modules.ModuleMetadataMap.ModuleMetadata

Enclosing class:

ModuleMetadataMap

public abstract static class ModuleMetadataMap.ModuleMetadata
extends java.lang.Object

Struct containing basic information about a module including its type and goog namespaces.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleMetadataMap.ModuleMetadata.Builder Builder for ModuleMetadataMap.ModuleMetadata.

Constructor Summary

Constructors

Constructor and Description
ModuleMetadata()

Method Summary

Modifier and Type	Method and Description
static ModuleMetadataMap.ModuleMetadata.Builder	builder()
boolean	equals(java.lang.Object other)
abstract com.google.common.collect.ImmutableMultiset<java.lang.String>	es6ImportSpecifiers() Raw text of all ES6 import specifiers (includes "export from" as well).
abstract com.google.common.collect.ImmutableMultiset<java.lang.String>	googNamespaces() Closure namespaces that this file is associated with.
int	hashCode()
boolean	isCommonJs()
boolean	isEs6Module()
boolean	isGoogModule()
boolean	isGoogProvide()
boolean	isLegacyGoogModule()
boolean	isNonLegacyGoogModule()
boolean	isScript()
abstract boolean	isTestOnly() Whether goog.setTestOnly was called.
abstract ModuleMetadataMap.ModuleType	moduleType()
abstract com.google.common.collect.ImmutableList<ModuleMetadataMap.ModuleMetadata>	nestedModules()
abstract ModuleLoader.ModulePath	path()
abstract com.google.common.collect.ImmutableMultiset<java.lang.String>	requiredGoogNamespaces() Closure namespaces this file requires.
abstract com.google.common.collect.ImmutableMultiset<java.lang.String>	requiredTypes() Closure namespaces this file has weak dependencies on.
abstract Node	rootNode() AST node that represents the root of this module.
abstract boolean	usesClosure() Whether this file uses Closure Library at all.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleMetadata

public ModuleMetadata()

Method Detail

moduleType

public abstract ModuleMetadataMap.ModuleType moduleType()

isEs6Module

public boolean isEs6Module()

isGoogModule

public boolean isGoogModule()

isNonLegacyGoogModule

public boolean isNonLegacyGoogModule()

isLegacyGoogModule

public boolean isLegacyGoogModule()

isGoogProvide

public boolean isGoogProvide()

isCommonJs

public boolean isCommonJs()

isScript

public boolean isScript()

rootNode

@Nullable
public abstract Node rootNode()

AST node that represents the root of this module.

May be null if this is a synthetic piece of metadata - e.g. in a test, or something used as a fallback.

usesClosure

public abstract boolean usesClosure()

Whether this file uses Closure Library at all. Note that a file could use Closure Library even without calling goog.provide/module/require - there are some primitives in base.js that can be used without being required like goog.isArray.

If this is true this indicates the base.js is needed and is not part of this script - it is an EXTERNAL dependencym otherwise false. If this is also false if Closure Library is part of this script - e.g. a bundle with base.js. So something could be a "goog.provide'd file", but not use Closure if the bundle already contains Closure.

isTestOnly

public abstract boolean isTestOnly()

Whether goog.setTestOnly was called.

googNamespaces

public abstract com.google.common.collect.ImmutableMultiset<java.lang.String> googNamespaces()

Closure namespaces that this file is associated with. Created by goog.provide, goog.module, and goog.declareModuleId.

This is a multiset as it does not warn on duplicate namespaces, but will still encapsulate that information with this multiset.

requiredGoogNamespaces

public abstract com.google.common.collect.ImmutableMultiset<java.lang.String> requiredGoogNamespaces()

Closure namespaces this file requires. e.g. all arguments to goog.require calls.

This is a multiset as it does not warn on duplicate namespaces, but will still encapsulate that information with this multiset.

requiredTypes

public abstract com.google.common.collect.ImmutableMultiset<java.lang.String> requiredTypes()

Closure namespaces this file has weak dependencies on. e.g. all arguments to goog.requireType calls.

This is a multiset as it does not warn on duplicate namespaces, but will still encapsulate that information with this multiset.

es6ImportSpecifiers

public abstract com.google.common.collect.ImmutableMultiset<java.lang.String> es6ImportSpecifiers()

Raw text of all ES6 import specifiers (includes "export from" as well).

nestedModules

public abstract com.google.common.collect.ImmutableList<ModuleMetadataMap.ModuleMetadata> nestedModules()

path

@Nullable
public abstract ModuleLoader.ModulePath path()

builder

public static ModuleMetadataMap.ModuleMetadata.Builder builder()

equals

public final boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object