com.google.javascript.jscomp

Class ChromeCodingConvention

java.lang.Object

com.google.javascript.jscomp.CodingConventions.Proxy

com.google.javascript.jscomp.ChromeCodingConvention

All Implemented Interfaces:

CodingConvention, Serializable

public class ChromeCodingConvention
extends CodingConventions.Proxy

See Also:

Serialized Form

Nested Class Summary

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

CodingConvention.AssertionFunctionSpec, CodingConvention.Bind, CodingConvention.Cache, 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
ChromeCodingConvention()
ChromeCodingConvention(CodingConvention wrapped)

Method Summary

Modifier and Type	Method and Description
void	applySingletonGetterOld(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.
Collection<CodingConvention.AssertionFunctionSpec>	getAssertionFunctions() Returns the set of AssertionFunction.
Collection<String>	getIndirectlyDeclaredProperties() Gets a collection of all properties that are defined indirectly on global objects.
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.
boolean	isFunctionCallThatAlwaysThrows(Node n) Used by CheckMissingReturn.

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

applyDelegateRelationship, applySingletonGetterNew, applySubclassRelationship, blockRenamingForProperty, checkForCallingConventionDefiningCalls, defineDelegateProxyPrototypeProperties, describeCachingCall, describeFunctionBind, describeFunctionBind, extractClassNameIfProvide, extractClassNameIfRequire, extractIsModuleFile, getAbstractMethodName, getClassesDefinedByCall, getDelegateRelationship, getDelegateSuperclassName, getExportPropertyFunction, getExportSymbolFunction, getGlobalObject, getObjectLiteralCast, getPackageName, hasPrivacyConvention, identifyTypeDeclarationCall, isClassFactoryCall, isConstant, isConstantKey, isExported, isExported, isInlinableFunction, isOptionalParameter, isPrivate, isPropertyRenameFunction, isPropertyTestFunction, isPrototypeAlias, isSuperClassReference, isValidEnumKey, isVarArgsParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

ChromeCodingConvention

public ChromeCodingConvention()

ChromeCodingConvention

public ChromeCodingConvention(CodingConvention wrapped)

Method Detail

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.

applySingletonGetterOld

public void applySingletonGetterOld(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:

applySingletonGetterOld in interface CodingConvention

Overrides:

applySingletonGetterOld in class CodingConventions.Proxy

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

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

isFunctionCallThatAlwaysThrows

public boolean isFunctionCallThatAlwaysThrows(Node n)

Description copied from interface: CodingConvention

Used by CheckMissingReturn. When a function call always throws an error, it can be the last stm of a block and we don't warn about missing return.

Specified by:

isFunctionCallThatAlwaysThrows in interface CodingConvention

Overrides:

isFunctionCallThatAlwaysThrows in class CodingConventions.Proxy