com.google.template.soy.msgs.restricted

Class SoyMsgPluralPart

java.lang.Object

com.google.template.soy.msgs.restricted.SoyMsgPart

com.google.template.soy.msgs.restricted.SoyMsgPluralPart

public final class SoyMsgPluralPart
extends SoyMsgPart

Represents a plural statement within a message.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.template.soy.msgs.restricted.SoyMsgPart

SoyMsgPart.Case<T>

Constructor Summary

Constructors

Constructor and Description
SoyMsgPluralPart(String pluralVarName, int offset, Iterable<SoyMsgPart.Case<SoyMsgPluralCaseSpec>> cases)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
com.google.common.collect.ImmutableList<SoyMsgPart.Case<SoyMsgPluralCaseSpec>>	getCases() Returns the cases.
int	getOffset() Returns the offset.
String	getPluralVarName() Returns the plural variable name.
int	hashCode()
com.google.common.collect.ImmutableList<SoyMsgPart>	lookupCase(long pluralValue, com.ibm.icu.util.ULocale locale) Returns the list of parts to implement the case.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoyMsgPluralPart

public SoyMsgPluralPart(String pluralVarName,
                        int offset,
                        Iterable<SoyMsgPart.Case<SoyMsgPluralCaseSpec>> cases)

Parameters:

pluralVarName - The plural variable name.

offset - The offset for this plural statement.

cases - The list of cases for this plural statement.

Method Detail

getPluralVarName

public String getPluralVarName()

Returns the plural variable name.

getOffset

public int getOffset()

Returns the offset.

getCases

public com.google.common.collect.ImmutableList<SoyMsgPart.Case<SoyMsgPluralCaseSpec>> getCases()

Returns the cases.

lookupCase

public com.google.common.collect.ImmutableList<SoyMsgPart> lookupCase(long pluralValue,
                                                                      @Nullable
                                                                      com.ibm.icu.util.ULocale locale)

Returns the list of parts to implement the case.

Parameters:

pluralValue - The current plural value

locale - The locale for interpreting non-specific plural parts. Allowed to be null if it is known that there are no non-specific plural parts (This is commonly the case for default messages, since soy only allows direct specification of explicit or 'other').

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object