com.google.template.soy.internal.i18n

Class BidiGlobalDir

java.lang.Object

com.google.template.soy.internal.i18n.BidiGlobalDir

public final class BidiGlobalDir
extends Object

Bidi global direction, which is either a "static" integer value (ltr=1, rtl=-1), or a code snippet yielding such a value when evaluated at template runtime.

Important: Do not use outside of Soy code (treat as superpackage-private).

Field Summary

Fields

Modifier and Type	Field and Description
static BidiGlobalDir	LTR
static BidiGlobalDir	RTL

Method Summary

Modifier and Type	Method and Description
static BidiGlobalDir	forIsRtlCodeSnippet(String isRtlCodeSnippet, String namespace, SoyBackendKind backend) Creates a bidi global direction that can only be determined at template runtime, by evaluating a given source code snippet that yields a boolean value where true indicates rtl.
static BidiGlobalDir	forStaticIsRtl(boolean isRtl) Creates a "static" bidi global direction, i.e.
static BidiGlobalDir	forStaticLocale(String localeString) Creates a "static" bidi global direction, i.e.
String	getCodeSnippet() A source code snippet that evaluates at template runtime to the bidi global direction, i.e.
com.google.common.base.Optional<String>	getNamespace()
int	getStaticValue() The "static" bidi global direction, as an integer: ltr=1, rtl=-1.
boolean	isStaticValue() Returns whether the bidi global direction is "static", i.e.
Dir	toDir() Converts this into a Dir if it represents LTR or RTL.

Methods inherited from class java.lang.Object

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

Field Detail

LTR

public static final BidiGlobalDir LTR

RTL

public static final BidiGlobalDir RTL

Method Detail

forStaticIsRtl

public static BidiGlobalDir forStaticIsRtl(boolean isRtl)

Creates a "static" bidi global direction, i.e. one known at the time of the call, given a boolean value where true indicates rtl.

Parameters:

isRtl - Whether the global direction value is rtl. Otherwise, it is ltr.

forStaticLocale

public static BidiGlobalDir forStaticLocale(@Nullable
                                            String localeString)

Creates a "static" bidi global direction, i.e. one known at the time of the call, based on a locale string. A null locale indicates ltr.

Parameters:

localeString - A BCP 47 locale string. If null, indicates ltr.

forIsRtlCodeSnippet

public static BidiGlobalDir forIsRtlCodeSnippet(String isRtlCodeSnippet,
                                                @Nullable
                                                String namespace,
                                                SoyBackendKind backend)

Creates a bidi global direction that can only be determined at template runtime, by evaluating a given source code snippet that yields a boolean value where true indicates rtl.

Parameters:

isRtlCodeSnippet - A code snippet that will evaluate at template runtime to a boolean value indicating whether the bidi global direction is rtl.

backend - The current backend target.

isStaticValue

public boolean isStaticValue()

Returns whether the bidi global direction is "static", i.e. is available now via getStaticValue(), as opposed to having to be determined at template runtime by evaluating the code returned by getCodeSnippet().

getStaticValue

public int getStaticValue()

The "static" bidi global direction, as an integer: ltr=1, rtl=-1. If the bidi global direction is non-static, then calling this method will produce an exception.

getCodeSnippet

public String getCodeSnippet()

A source code snippet that evaluates at template runtime to the bidi global direction, i.e. one of the integer values 1 (ltr), 0 (unknown), and -1 (rtl). When the bidi global direction is static, returns a string representing an integer literal, e.g. "1". Thus, should never be null or empty.

getNamespace

public com.google.common.base.Optional<String> getNamespace()

toDir

public Dir toDir()

Converts this into a Dir if it represents LTR or RTL.