com.google.javascript.jscomp

Class ClosureCodingConvention

java.lang.Object

com.google.javascript.jscomp.CodingConventions.Proxy

com.google.javascript.jscomp.ClosureCodingConvention

All Implemented Interfaces:

CodingConvention, Serializable

public class ClosureCodingConvention
extends CodingConventions.Proxy

This describes the Closure-specific JavaScript coding conventions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClosureCodingConvention.AssertFunctionByTypeName A function that will throw an exception when the value is not an instanceof the given type name, for instance "Element".
static class	ClosureCodingConvention.AssertInstanceofSpec A function that will throw an exception when if the value is not an instanceof a specific type.

Nested classes/interfaces inherited from interface com.google.javascript.jscomp.CodingConvention

CodingConvention.AssertionFunctionSpec, CodingConvention.Bind, CodingConvention.DelegateRelationship, CodingConvention.ObjectLiteralCast, CodingConvention.SubclassRelationship, CodingConvention.SubclassType

Field Summary

Fields inherited from class com.google.javascript.jscomp.CodingConventions.Proxy

nextConvention

Constructor Summary

Constructors

Constructor and Description
ClosureCodingConvention()
ClosureCodingConvention(CodingConvention wrapped)

Method Summary

Methods

Modifier and Type	Method and Description
void	applySingletonGetter(FunctionType functionType, FunctionType getterType, ObjectType objectType) In many JS libraries, the function that adds a singleton getter to a class adds properties to the class.
void	applySubclassRelationship(FunctionType parentCtor, FunctionType childCtor, CodingConvention.SubclassType type) Closure's goog.inherits adds a superClass_ property to the subclass, and a constructor property.
CodingConvention.Bind	describeFunctionBind(Node n, boolean useTypeInfo) A Bind instance or null.
String	extractClassNameIfProvide(Node node, Node parent) Extracts X from goog.provide('X'), if the applied Node is goog.
String	extractClassNameIfRequire(Node node, Node parent) Extracts X from goog.require('X'), if the applied Node is goog.
boolean	extractIsModuleFile(Node node, Node parent) Convenience method for determining if the node indicates the file is a "module" file (a file whose top level symbols are not in global scope).
String	getAbstractMethodName() Function name for abstract methods.
Collection<CodingConvention.AssertionFunctionSpec>	getAssertionFunctions() Returns the set of AssertionFunction.
CodingConvention.SubclassRelationship	getClassesDefinedByCall(Node callNode) Checks if the given method defines a subclass relationship, and if it does, returns information on that relationship.
String	getExportPropertyFunction() Use closure's implementation.
String	getExportSymbolFunction() Use closure's implementation.
String	getGlobalObject() Gets the name of the global object.
Collection<String>	getIndirectlyDeclaredProperties() Gets a collection of all properties that are defined indirectly on global objects.
CodingConvention.ObjectLiteralCast	getObjectLiteralCast(Node callNode) Checks if the given method performs a object literal cast, and if it does, returns information on the cast.
String	getSingletonGetterClassName(Node callNode) Checks if the given method defines a singleton getter, and if it does, returns the name of the class with the singleton getter.
List<String>	identifyTypeDeclarationCall(Node n) Checks if the given CALL node is forward-declaring any types, and returns the name of the types if it is.
boolean	isPrivate(String name) Checks whether a name should be considered private.
boolean	isPropertyTestFunction(Node call) Whether this CALL function is testing for the existence of a property.
boolean	isSuperClassReference(String propertyName) Returns true if passed a string referring to the superclass.

Methods inherited from class com.google.javascript.jscomp.CodingConventions.Proxy

applyDelegateRelationship, checkForCallingConventionDefiningCalls, defineDelegateProxyPrototypeProperties, describeFunctionBind, getDelegateRelationship, getDelegateSuperclassName, getPackageName, isConstant, isConstantKey, isExported, isExported, isInlinableFunction, isOptionalParameter, isPrototypeAlias, isValidEnumKey, isVarArgsParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

ClosureCodingConvention

public ClosureCodingConvention()

ClosureCodingConvention

public ClosureCodingConvention(CodingConvention wrapped)

Method Detail

applySubclassRelationship

public void applySubclassRelationship(FunctionType parentCtor,
                             FunctionType childCtor,
                             CodingConvention.SubclassType type)

Closure's goog.inherits adds a superClass_ property to the subclass, and a constructor property.

Specified by:

applySubclassRelationship in interface CodingConvention

Overrides:

applySubclassRelationship in class CodingConventions.Proxy

getClassesDefinedByCall

public CodingConvention.SubclassRelationship getClassesDefinedByCall(Node callNode)

Checks if the given method defines a subclass relationship, and if it does, returns information on that relationship. By default, always returns null. Meant to be overridden by subclasses.

Understands several different inheritance patterns that occur in Google code (various uses of inherits and mixin).

Specified by:

getClassesDefinedByCall in interface CodingConvention

Overrides:

getClassesDefinedByCall in class CodingConventions.Proxy

Parameters:

callNode - A CALL node.

isSuperClassReference

public boolean isSuperClassReference(String propertyName)

Description copied from interface: CodingConvention

Returns true if passed a string referring to the superclass. The string will usually be from the string node at the right of a GETPROP, e.g. this.superClass_.

Specified by:

isSuperClassReference in interface CodingConvention

Overrides:

isSuperClassReference in class CodingConventions.Proxy

extractIsModuleFile

public boolean extractIsModuleFile(Node node,
                          Node parent)

Description copied from interface: CodingConvention

Convenience method for determining if the node indicates the file is a "module" file (a file whose top level symbols are not in global scope).

Specified by:

extractIsModuleFile in interface CodingConvention

Overrides:

extractIsModuleFile in class CodingConventions.Proxy

Returns:

Whether the node indicates that the file represents a "module", a file whose top level declarations are not in global scope.

extractClassNameIfProvide

public String extractClassNameIfProvide(Node node,
                               Node parent)

Extracts X from goog.provide('X'), if the applied Node is goog.

Specified by:

extractClassNameIfProvide in interface CodingConvention

Overrides:

extractClassNameIfProvide in class CodingConventions.Proxy

Returns:

The extracted class name, or null.

extractClassNameIfRequire

public String extractClassNameIfRequire(Node node,
                               Node parent)

Extracts X from goog.require('X'), if the applied Node is goog.

Specified by:

extractClassNameIfRequire in interface CodingConvention

Overrides:

extractClassNameIfRequire in class CodingConventions.Proxy

Returns:

The extracted class name, or null.

getExportPropertyFunction

public String getExportPropertyFunction()

Use closure's implementation.

Specified by:

getExportPropertyFunction in interface CodingConvention

Overrides:

getExportPropertyFunction in class CodingConventions.Proxy

Returns:

closure's function name for exporting properties.

getExportSymbolFunction

public String getExportSymbolFunction()

Use closure's implementation.

Specified by:

getExportSymbolFunction in interface CodingConvention

Overrides:

getExportSymbolFunction in class CodingConventions.Proxy

Returns:

closure's function name for exporting symbols.

identifyTypeDeclarationCall

public List<String> identifyTypeDeclarationCall(Node n)

Description copied from interface: CodingConvention

Checks if the given CALL node is forward-declaring any types, and returns the name of the types if it is.

Specified by:

identifyTypeDeclarationCall in interface CodingConvention

Overrides:

identifyTypeDeclarationCall in class CodingConventions.Proxy

getAbstractMethodName

public String getAbstractMethodName()

Description copied from interface: CodingConvention

Function name for abstract methods. An abstract method can be assigned to an interface method instead of an function expression in order to avoid linter warnings produced by assigning a function without a return value where a return value is expected.

Specified by:

getAbstractMethodName in interface CodingConvention

Overrides:

getAbstractMethodName in class CodingConventions.Proxy

Returns:

function name.

getSingletonGetterClassName

public String getSingletonGetterClassName(Node callNode)

Description copied from interface: CodingConvention

Checks if the given method defines a singleton getter, and if it does, returns the name of the class with the singleton getter. By default, always returns null. Meant to be overridden by subclasses. addSingletonGetter needs a coding convention because in the general case, it can't be inlined. The function inliner sees that it creates an alias to the given class in an inner closure, and bails out.

Specified by:

getSingletonGetterClassName in interface CodingConvention

Overrides:

getSingletonGetterClassName in class CodingConventions.Proxy

Parameters:

callNode - A CALL node.

applySingletonGetter

public void applySingletonGetter(FunctionType functionType,
                        FunctionType getterType,
                        ObjectType objectType)

Description copied from interface: CodingConvention

In many JS libraries, the function that adds a singleton getter to a class adds properties to the class.

Specified by:

applySingletonGetter in interface CodingConvention

Overrides:

applySingletonGetter in class CodingConventions.Proxy

getGlobalObject

public String getGlobalObject()

Description copied from interface: CodingConvention

Gets the name of the global object.

Specified by:

getGlobalObject in interface CodingConvention

Overrides:

getGlobalObject in class CodingConventions.Proxy

isPropertyTestFunction

public boolean isPropertyTestFunction(Node call)

Description copied from interface: CodingConvention

Whether this CALL function is testing for the existence of a property.

Specified by:

isPropertyTestFunction in interface CodingConvention

Overrides:

isPropertyTestFunction in class CodingConventions.Proxy

getObjectLiteralCast

public CodingConvention.ObjectLiteralCast getObjectLiteralCast(Node callNode)

Description copied from interface: CodingConvention

Checks if the given method performs a object literal cast, and if it does, returns information on the cast. By default, always returns null. Meant to be overridden by subclasses.

Specified by:

getObjectLiteralCast in interface CodingConvention

Overrides:

getObjectLiteralCast in class CodingConventions.Proxy

Parameters:

callNode - A CALL node.

isPrivate

public boolean isPrivate(String name)

Description copied from interface: CodingConvention

Checks whether a name should be considered private. Private global variables and functions can only be referenced within the source file in which they are declared. Private properties and methods should only be accessed by the class that defines them.

Specified by:

isPrivate in interface CodingConvention

Overrides:

isPrivate in class CodingConventions.Proxy

Parameters:

name - The name of a global variable or function, or a method or property.

Returns:

true if the name should be considered private.

getAssertionFunctions

public Collection<CodingConvention.AssertionFunctionSpec> getAssertionFunctions()

Description copied from interface: CodingConvention

Returns the set of AssertionFunction.

Specified by:

getAssertionFunctions in interface CodingConvention

Overrides:

getAssertionFunctions in class CodingConventions.Proxy

describeFunctionBind

public CodingConvention.Bind describeFunctionBind(Node n,
                                         boolean useTypeInfo)

Description copied from interface: CodingConvention

A Bind instance or null.

Specified by:

describeFunctionBind in interface CodingConvention

Overrides:

describeFunctionBind in class CodingConventions.Proxy

useTypeInfo - If we believe type information is reliable enough to use to figure out what the bind function is.

getIndirectlyDeclaredProperties

public Collection<String> getIndirectlyDeclaredProperties()

Description copied from interface: CodingConvention

Gets a collection of all properties that are defined indirectly on global objects. (For example, Closure defines superClass_ in the goog.inherits call).

Specified by:

getIndirectlyDeclaredProperties in interface CodingConvention

Overrides:

getIndirectlyDeclaredProperties in class CodingConventions.Proxy