com.google.template.soy.jssrc.dsl

Class GoogRequire

java.lang.Object

com.google.template.soy.jssrc.dsl.GoogRequire

All Implemented Interfaces:

Comparable<GoogRequire>

public abstract class GoogRequire
extends Object
implements Comparable<GoogRequire>

Represents a symbol that is imported via a goog.require statement.

Constructor Summary

Constructors

Constructor and Description
GoogRequire()

Method Summary

Modifier and Type	Method and Description
int	compareTo(GoogRequire o)
static GoogRequire	create(String symbol) Creates a new GoogRequire that requires the given symbol: goog.require('symbol');
static GoogRequire	createWithAlias(String symbol, String alias) Creates a new GoogRequire that requires the given symbol and aliases it to the given name: var alias = goog.require('symbol');
CodeChunk.WithValue	dotAccess(String ident) Access a member of this required symbol.
CodeChunk.WithValue	reference() Returns a code chunk that can act as a reference to the required symbol.
abstract String	symbol() The symbol to require.
void	writeTo(StringBuilder sb)

Methods inherited from class java.lang.Object

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

Constructor Detail

GoogRequire

public GoogRequire()

Method Detail

create

public static GoogRequire create(String symbol)

Creates a new GoogRequire that requires the given symbol: goog.require('symbol');

createWithAlias

public static GoogRequire createWithAlias(String symbol,
                                          String alias)

Creates a new GoogRequire that requires the given symbol and aliases it to the given name: var alias = goog.require('symbol');

symbol

public abstract String symbol()

The symbol to require.

reference

public CodeChunk.WithValue reference()

Returns a code chunk that can act as a reference to the required symbol.

dotAccess

public CodeChunk.WithValue dotAccess(String ident)

Access a member of this required symbol.

writeTo

public void writeTo(StringBuilder sb)

compareTo

public final int compareTo(GoogRequire o)

Specified by:

compareTo in interface Comparable<GoogRequire>