Index
All Classes and Interfaces|All Packages|Serialized Form
A
- add(T) - Method in class com.lokalized.Range
-
Deprecated.Unsupported operation; this type is immutable.
- addAll(Collection<? extends T>) - Method in class com.lokalized.Range
-
Deprecated.Unsupported operation; this type is immutable.
- alternatives(List<LocalizedString>) - Method in class com.lokalized.LocalizedString.Builder
-
Applies alternative expression-driven translations to this builder.
B
- build() - Method in class com.lokalized.DefaultStrings.Builder
-
Constructs an instance of
DefaultStrings
. - build() - Method in class com.lokalized.LocalizedString.Builder
-
Constructs an instance of
LocalizedString
. - Builder(String) - Constructor for class com.lokalized.LocalizedString.Builder
-
Constructs a localized string builder with the given key.
- Builder(String, Supplier<Map<Locale, ? extends Iterable<LocalizedString>>>) - Constructor for class com.lokalized.DefaultStrings.Builder
-
Constructs a strings builder with a default language code and localized string supplier.
C
- Cardinality - Enum Class in com.lokalized
-
Language plural cardinality forms.
- clear() - Method in class com.lokalized.Range
-
Deprecated.Unsupported operation; this type is immutable.
- com.lokalized - package com.lokalized
-
Lokalized facilitates natural-sounding software translations.
- commentary(String) - Method in class com.lokalized.LocalizedString.Builder
-
Applies commentary (usage/translation notes) to this builder.
- contains(Object) - Method in class com.lokalized.Range
-
Returns true if this range contains the specified value.
- containsAll(Collection<?>) - Method in class com.lokalized.Range
-
Returns true if this range contains all of the elements of the specified collection.
D
- DefaultStrings - Class in com.lokalized
-
Default implementation of a localized string provider.
- DefaultStrings.Builder - Class in com.lokalized
-
Builder used to construct instances of
DefaultStrings
. - DefaultStrings.FailureMode - Enum Class in com.lokalized
-
Strategies for handling localized string lookup failures.
E
- emptyFiniteRange() - Static method in class com.lokalized.Range
-
Gets the empty finite range.
- emptyInfiniteRange() - Static method in class com.lokalized.Range
-
Gets the empty infinite range.
- equals(Object) - Method in class com.lokalized.LocalizedString
-
Checks if this object is equal to another one.
- equals(Object) - Method in class com.lokalized.LocalizedString.LanguageFormTranslation
-
Checks if this object is equal to another one.
- equals(Object) - Method in class com.lokalized.LocalizedString.LanguageFormTranslationRange
-
Checks if this object is equal to another one.
- equals(Object) - Method in class com.lokalized.Range
-
Checks if this object is equal to another one.
- exampleDecimalValuesForLocale(Locale) - Static method in enum class com.lokalized.Cardinality
-
Gets a mapping of cardinalities to example decimal values for the given locale.
- exampleIntegerValuesForLocale(Locale) - Static method in enum class com.lokalized.Cardinality
-
Gets a mapping of cardinalities to example integer values for the given locale.
- exampleIntegerValuesForLocale(Locale) - Static method in enum class com.lokalized.Ordinality
-
Gets a mapping of ordinalities to example integer values for the given locale.
- ExpressionEvaluationException - Exception Class in com.lokalized
-
Exception which indicates a problem encountered while evaluating a localized string expression.
- ExpressionEvaluationException(String) - Constructor for exception class com.lokalized.ExpressionEvaluationException
-
Constructs a new exception with the specified message.
- ExpressionEvaluationException(String, Throwable) - Constructor for exception class com.lokalized.ExpressionEvaluationException
-
Constructs a new exception with the specified message and cause.
F
- FAIL_FAST - Enum constant in enum class com.lokalized.DefaultStrings.FailureMode
-
The system will throw an exception if a localization is missing for the specified locale.
- failureMode(DefaultStrings.FailureMode) - Method in class com.lokalized.DefaultStrings.Builder
-
Applies a failure mode to this builder.
- FEMININE - Enum constant in enum class com.lokalized.Gender
-
Feminine gender.
- FEW - Enum constant in enum class com.lokalized.Cardinality
-
The form that falls between
TWO
andMANY
. - FEW - Enum constant in enum class com.lokalized.Ordinality
-
The form that falls between
TWO
andMANY
. - forNumber(Number, Integer, Locale) - Static method in enum class com.lokalized.Cardinality
-
Gets an appropriate plural cardinality for the given number, visible decimal places, and locale.
- forNumber(Number, Locale) - Static method in enum class com.lokalized.Cardinality
-
Gets an appropriate plural cardinality for the given number and locale.
- forNumber(Number, Locale) - Static method in enum class com.lokalized.Ordinality
-
Gets an appropriate plural ordinality for the given number and locale.
- forRange(Cardinality, Cardinality, Locale) - Static method in enum class com.lokalized.Cardinality
-
Gets an appropriate plural cardinality for the given range (start, end) and locale.
G
- Gender - Enum Class in com.lokalized
-
Language gender forms.
- get(String) - Method in class com.lokalized.DefaultStrings
- get(String) - Method in interface com.lokalized.Strings
-
Gets a localized string for the given key.
- get(String, Locale) - Method in class com.lokalized.DefaultStrings
- get(String, Locale) - Method in interface com.lokalized.Strings
-
Gets a localized string for the given key.
- get(String, Map<String, Object>) - Method in class com.lokalized.DefaultStrings
- get(String, Map<String, Object>) - Method in interface com.lokalized.Strings
-
Gets a localized string for the given key.
- get(String, Map<String, Object>, Locale) - Method in class com.lokalized.DefaultStrings
- get(String, Map<String, Object>, Locale) - Method in interface com.lokalized.Strings
-
Gets a localized string for the given key.
- getAlternatives() - Method in class com.lokalized.LocalizedString
-
Gets alternative expression-driven translations for this string.
- getCommentary() - Method in class com.lokalized.LocalizedString
-
Gets this string's commentary (usage/translation notes).
- getEnd() - Method in class com.lokalized.LocalizedString.LanguageFormTranslationRange
-
The end value for this range.
- getFailureMode() - Method in class com.lokalized.DefaultStrings
-
Gets the strategy for handling string lookup failures.
- getFallbackLanguageCode() - Method in class com.lokalized.DefaultStrings
-
Gets the fallback language code.
- getInfinite() - Method in class com.lokalized.Range
-
Gets whether this range is infinite.
- getKey() - Method in class com.lokalized.LocalizedString
-
Gets this string's translation key.
- getLanguageFormTranslationsByPlaceholder() - Method in class com.lokalized.LocalizedString
-
Gets per-language-form translations that correspond to a placeholder value.
- getLocale() - Method in exception class com.lokalized.UnsupportedLocaleException
-
The unsupported locale that triggered this exception.
- getLocalizedStringsByLocale() - Method in class com.lokalized.DefaultStrings
-
Gets the set of localized strings for each locale.
- getRange() - Method in class com.lokalized.LocalizedString.LanguageFormTranslation
-
Gets the range for this per-language-form translation set.
- getStart() - Method in class com.lokalized.LocalizedString.LanguageFormTranslationRange
-
The start value for this range.
- getSupportedLanguageCodes() - Static method in enum class com.lokalized.Cardinality
-
Gets the ISO 639 language codes for which cardinality operations are supported.
- getSupportedLanguageCodes() - Static method in enum class com.lokalized.Ordinality
-
Gets the ISO 639 language codes for which ordinality operations are supported.
- getTranslation() - Method in class com.lokalized.LocalizedString
-
Gets this string's default translation, if available.
- getTranslationsByLanguageForm() - Method in class com.lokalized.LocalizedString.LanguageFormTranslation
-
Gets the translations by language form for this per-language-form translation set.
- getValue() - Method in class com.lokalized.LocalizedString.LanguageFormTranslation
-
Gets the value for this per-language-form translation set.
- getValues() - Method in class com.lokalized.Range
-
Gets the values that comprise this range.
H
- hashCode() - Method in class com.lokalized.LocalizedString
-
A hash code for this object.
- hashCode() - Method in class com.lokalized.LocalizedString.LanguageFormTranslation
-
A hash code for this object.
- hashCode() - Method in class com.lokalized.LocalizedString.LanguageFormTranslationRange
-
A hash code for this object.
- hashCode() - Method in class com.lokalized.Range
-
A hash code for this object.
I
- isEmpty() - Method in class com.lokalized.Range
-
Returns true if this range contains no elements.
- iterator() - Method in class com.lokalized.Range
-
Returns an iterator over the values in this range in proper sequence.
L
- LanguageForm - Interface in com.lokalized
-
Marker interface which signifies a language construct (genders, cardinalities, ordinalities).
- LanguageFormTranslation(LocalizedString.LanguageFormTranslationRange, Map<LanguageForm, String>) - Constructor for class com.lokalized.LocalizedString.LanguageFormTranslation
-
Constructs a per-language-form translation set with the given placeholder range and mapping of translations by language form.
- LanguageFormTranslation(String, Map<LanguageForm, String>) - Constructor for class com.lokalized.LocalizedString.LanguageFormTranslation
-
Constructs a per-language-form translation set with the given placeholder value and mapping of translations by language form.
- LanguageFormTranslationRange(String, String) - Constructor for class com.lokalized.LocalizedString.LanguageFormTranslationRange
-
Constructs a translation range with the given start and end values.
- languageFormTranslationsByPlaceholder(Map<String, LocalizedString.LanguageFormTranslation>) - Method in class com.lokalized.LocalizedString.Builder
-
Applies per-language-form translations to this builder.
- languageRangesSupplier(Supplier<List<Locale.LanguageRange>>) - Method in class com.lokalized.DefaultStrings.Builder
-
Applies a supplier of language ranges to this builder.
- loadFromClasspath(String) - Static method in class com.lokalized.LocalizedStringLoader
-
Loads all localized string files present in the specified package on the classpath.
- loadFromFilesystem(Path) - Static method in class com.lokalized.LocalizedStringLoader
-
Loads all localized string files present in the specified directory.
- localeSupplier(Supplier<Locale>) - Method in class com.lokalized.DefaultStrings.Builder
-
Applies a locale supplier to this builder.
- LocalizedString - Class in com.lokalized
-
Represents a single localized string - its key, translated value, and any associated translation rules.
- LocalizedString.Builder - Class in com.lokalized
-
Builder used to construct instances of
LocalizedString
. - LocalizedString.LanguageFormTranslation - Class in com.lokalized
-
Container for per-language-form (gender, cardinal, ordinal) translation information.
- LocalizedString.LanguageFormTranslationRange - Class in com.lokalized
-
Container for per-language-form cardinality translation information over a range (start, end) of values.
- LocalizedStringLoader - Class in com.lokalized
-
Utility methods for loading localized strings files.
- LocalizedStringLoadingException - Exception Class in com.lokalized
-
Exception which indicates a problem encountered while processing a localized strings file.
- LocalizedStringLoadingException(String) - Constructor for exception class com.lokalized.LocalizedStringLoadingException
-
Constructs a new exception with the specified message.
- LocalizedStringLoadingException(String, Throwable) - Constructor for exception class com.lokalized.LocalizedStringLoadingException
-
Constructs a new exception with the specified message and cause.
M
- MANY - Enum constant in enum class com.lokalized.Cardinality
-
The form that falls between
FEW
andOTHER
. - MANY - Enum constant in enum class com.lokalized.Ordinality
-
The form that falls between
FEW
andOTHER
. - MASCULINE - Enum constant in enum class com.lokalized.Gender
-
Masculine gender.
N
O
- ofFiniteValues(Collection<T>) - Static method in class com.lokalized.Range
-
Provides a finite range for the given values.
- ofFiniteValues(T...) - Static method in class com.lokalized.Range
-
Provides a finite range for the given values.
- ofInfiniteValues(Collection<T>) - Static method in class com.lokalized.Range
-
Provides an infinite range for the given values.
- ofInfiniteValues(T...) - Static method in class com.lokalized.Range
-
Provides an infinite range for the given values.
- ONE - Enum constant in enum class com.lokalized.Cardinality
-
The form used with 1.
- ONE - Enum constant in enum class com.lokalized.Ordinality
-
The form used with 1.
- Ordinality - Enum Class in com.lokalized
-
Language plural ordinality forms.
- OTHER - Enum constant in enum class com.lokalized.Cardinality
-
General "catchall" form which comprises any cases not handled by the other forms.
- OTHER - Enum constant in enum class com.lokalized.Ordinality
-
General "catchall" form which comprises any cases not handled by the other forms.
R
- Range<T> - Class in com.lokalized
-
Represents a concrete range of values.
- remove(Object) - Method in class com.lokalized.Range
-
Deprecated.Unsupported operation; this type is immutable.
- removeAll(Collection<?>) - Method in class com.lokalized.Range
-
Deprecated.Unsupported operation; this type is immutable.
- retainAll(Collection<?>) - Method in class com.lokalized.Range
-
Deprecated.Unsupported operation; this type is immutable.
S
- size() - Method in class com.lokalized.Range
-
Returns the number of elements in this range.
- Strings - Interface in com.lokalized
-
Contract for localized string providers - given a key and placeholders, return a localized string.
- supportedCardinalitiesForLocale(Locale) - Static method in enum class com.lokalized.Cardinality
-
Gets the set of cardinalities supported for the given locale.
- supportedOrdinalitiesForLocale(Locale) - Static method in enum class com.lokalized.Ordinality
-
Gets the set of ordinalities supported for the given locale.
T
- toArray() - Method in class com.lokalized.Range
-
Returns an array containing all of the values in this range in proper sequence (from first to last value).
- toArray(T1[]) - Method in class com.lokalized.Range
-
Returns an array containing all of the values in this range in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.
- toString() - Method in class com.lokalized.LocalizedString.LanguageFormTranslation
-
Generates a
String
representation of this object. - toString() - Method in class com.lokalized.LocalizedString.LanguageFormTranslationRange
-
Generates a
String
representation of this object. - toString() - Method in class com.lokalized.LocalizedString
-
Generates a
String
representation of this object. - toString() - Method in class com.lokalized.Range
-
Generates a
String
representation of this object. - translation(String) - Method in class com.lokalized.LocalizedString.Builder
-
Applies a default translation to this builder.
- TWO - Enum constant in enum class com.lokalized.Cardinality
-
Normally the form used with 2, if it is limited to numbers whose integer values end with 2.
- TWO - Enum constant in enum class com.lokalized.Ordinality
-
Normally the form used with 2, if it is limited to numbers whose integer values end with 2.
U
- UnsupportedLocaleException - Exception Class in com.lokalized
-
Exception thrown when an operation was performed on a locale that is not recognized by the system.
- UnsupportedLocaleException(Locale) - Constructor for exception class com.lokalized.UnsupportedLocaleException
-
Constructs a new exception with the unsupported locale.
- USE_FALLBACK - Enum constant in enum class com.lokalized.DefaultStrings.FailureMode
-
The system will attempt a series of fallbacks in order to not throw an exception at runtime.
V
- valueOf(String) - Static method in enum class com.lokalized.Cardinality
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.lokalized.DefaultStrings.FailureMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.lokalized.Gender
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.lokalized.Ordinality
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.lokalized.Cardinality
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.lokalized.DefaultStrings.FailureMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.lokalized.Gender
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.lokalized.Ordinality
-
Returns an array containing the constants of this enum class, in the order they are declared.
Z
- ZERO - Enum constant in enum class com.lokalized.Cardinality
-
Normally the form used with 0, if it is limited to numbers whose integer values end with 0.
- ZERO - Enum constant in enum class com.lokalized.Ordinality
-
Normally the form used with 0, if it is limited to numbers whose integer values end with 0.
All Classes and Interfaces|All Packages|Serialized Form