Package com.transifex.common

Class Plurals

java.lang.Object

com.transifex.common.Plurals

public class Plurals
extends Object

An object representation of Android's plurals.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Plurals.Builder	A class for building a Plurals object.
static class	Plurals.InvalidPluralsConfiguration
static class	Plurals.NonSupportedPluralTypeException
static @interface	Plurals.PluralType	A tag that represents the plural type.

Field Summary

Fields

Modifier and Type	Field	Description
final String	few
final String	many
final String	one
final String	other
final String	two
final String	zero

Constructor Summary

Constructors

Constructor	Description
Plurals(String zero, String one, String two, String few, String many, String other)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
static Plurals	fromICUString(String icuString)	Parses the provided ICU string and creates a new Plurals object.
String	getPlural(String pluralType)	Returns the plural string for the provided plural type.
String	toICUString()	Returns the object as a string in ICU format.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

zero

public final String zero

one

public final String one

two

public final String two

few

public final String few

many

public final String many

other

public final String other

Constructor Details

Plurals

public Plurals(@Nullable
 String zero,
 @Nullable
 String one,
 @Nullable
 String two,
 @Nullable
 String few,
 @Nullable
 String many,
 @NonNull
 String other)
        throws Plurals.InvalidPluralsConfiguration

Creates a new instance.

Throws:

Plurals.InvalidPluralsConfiguration - if other is null.

Method Details

getPlural

@Nullable
public String getPlural(@NonNull
 String pluralType)

Returns the plural string for the provided plural type.

Parameters:

pluralType - The plural type of the string.

Returns:

The plural string for the provided plural type; the value will be null if no string exists for the provided plural

toICUString

@NonNull
public String toICUString()

Returns the object as a string in ICU format.

fromICUString

@Nullable
public static Plurals fromICUString(@NonNull
 String icuString)

Parses the provided ICU string and creates a new Plurals object.

Parameters:

icuString - The ICU string to parse.

Returns:

Returns a Plurals object if parsing was successful; null otherwise

toString

public String toString()

Overrides:

toString in class Object