MessageFormat Clase

Definición

[Android.Runtime.Register("android/icu/text/MessageFormat", ApiSince=24, DoNotGenerateAcw=true)]
public class MessageFormat : Android.Icu.Text.UFormat

[<Android.Runtime.Register("android/icu/text/MessageFormat", ApiSince=24, DoNotGenerateAcw=true)>]
type MessageFormat = class
    inherit UFormat

Herencia

Object

JavaObject

Object

_Format

UFormat

MessageFormat

Atributos

RegisterAttribute

Comentarios

<strong>[icu enhancement]</strong> ICU's replacement for java.text.MessageFormat.  Los métodos, los campos y otras funcionalidades específicas de ICU se etiquetan como "<strong>[icu]</strong>".

MessageFormat prepara cadenas para mostrar a los usuarios, con argumentos opcionales (variables o marcadores de posición). Los argumentos pueden producirse en cualquier orden, lo que es necesario para la traducción a idiomas con diferentes gramáticas.

MessageFormat se construye a partir de una <cadena em>pattern</em> con argumentos en {llaves} que se reemplazarán por valores con formato.

MessageFormat difiere de las demás Format clases en que se crea un MessageFormat objeto con uno de sus constructores (no con un getInstance método de generador de estilo). Los métodos de fábrica no son necesarios porque MessageFormat no implementa ningún comportamiento específico de la configuración regional. Cualquier comportamiento específico de la configuración regional se define mediante el patrón que se proporciona y los subformatos usados para los argumentos insertados.

Los argumentos se pueden denominar (mediante identificadores) o numerados (mediante enteros pequeños de dígitos ASCII). Algunos de los métodos de API solo funcionan con números de argumento y producen una excepción si el patrón tiene argumentos con nombre (vea #usesNamedArguments()).

Es posible que un argumento no especifique ningún tipo de formato. En este caso, se da formato a un valor Number con un valor numberFormat predeterminado (para la configuración regional), se da formato a un valor Date con un valor predeterminado (para la configuración regional) DateFormat y, para cualquier otro valor, se usa su valor toString().

Un argumento puede especificar un tipo "simple" para el que se crea, almacena en caché y se usa el objeto Format especificado.

Un argumento puede tener un tipo "complejo" con sub-patrones MessageFormat anidados. Durante el formato, se selecciona uno de estos mensajes secundarios según el valor del argumento y con formato recursivo.

Después de la construcción, se puede establecer un objeto Format personalizado para un argumento de nivel superior, invalidando el formato predeterminado y el comportamiento de análisis de ese argumento. Sin embargo, el formato personalizado se puede lograr más simplemente escribiendo un argumento sin tipo en la cadena de patrón y proporcionándolo con un valor de cadena con formato previo.

Al aplicar formato, MessageFormat toma una colección de valores de argumento y escribe una cadena de salida. Los valores de argumento se pueden pasar como una matriz (cuando el patrón solo contiene argumentos numerados) o como una asignación (que funciona para argumentos con nombre y numerados).

Cada argumento coincide con uno de los valores de entrada por índice de matriz o clave de asignación y tiene formato según su especificación de patrón (o mediante un objeto Format personalizado si se estableció uno). Un argumento de patrón numerado coincide con una clave de mapa que contiene ese número como una cadena de dígito decimal ASCII (sin cero inicial).

<h3>"patterns">Patterns and Their Interpretation</h3>

MessageFormat usa patrones de la forma siguiente: <blockquote>

message = messageText (argument messageText)*
            argument = noneArg | simpleArg | complexArg
            complexArg = choiceArg | pluralArg | selectArg | selectordinalArg

            noneArg = '{' argNameOrNumber '}'
            simpleArg = '{' argNameOrNumber ',' argType [',' argStyle] '}'
            choiceArg = '{' argNameOrNumber ',' "choice" ',' choiceStyle '}'
            pluralArg = '{' argNameOrNumber ',' "plural" ',' pluralStyle '}'
            selectArg = '{' argNameOrNumber ',' "select" ',' selectStyle '}'
            selectordinalArg = '{' argNameOrNumber ',' "selectordinal" ',' pluralStyle '}'

            choiceStyle: see {@link ChoiceFormat}
            pluralStyle: see {@link PluralFormat}
            selectStyle: see {@link SelectFormat}

            argNameOrNumber = argName | argNumber
            argName = [^[[:Pattern_Syntax:][:Pattern_White_Space:]]]+
            argNumber = '0' | ('1'..'9' ('0'..'9')*)

            argType = "number" | "date" | "time" | "spellout" | "ordinal" | "duration"
            argStyle = "short" | "medium" | "long" | "full" | "integer" | "currency" | "percent" | argStyleText

</blockquote>

<ul><li>messageText puede contener cadenas literales entre comillas, incluidos caracteres de sintaxis. Una cadena literal entre comillas comienza con un apóstrofo ASCII y un carácter de sintaxis (normalmente una llave {}) y continúa hasta el siguiente apóstrofo único. Un apóstrofo ASCII doble dentro o fuera de una cadena entre comillas representa un apóstrofo literal. <Los caracteres de sintaxis li>quotable son las {llaves} en todas las partes messageText, además del inicio de sesión '#' en un messageText inmediatamente dentro de un pluralStyle, y el símbolo '|' de un messageText inmediatamente dentro de un choiceStyle. <li>See also MessagePattern.ApostropheMode<li>In argStyleText, every single ASCII apóstrofo begins and ends quoted literal text, and unquoted {curly braces} must occur in matched pairs. </ul>

Recomendación: Use el carácter real de apóstrofo (comillas simples) \\u2019 para texto legible para humanos y use el apóstrofo ASCII (\\u0027 ' ) solo en la sintaxis del programa, como las comillas en MessageFormat. Consulte las anotaciones de U+0027 Aptrophe en El estándar Unicode.

El choice tipo de argumento está en desuso. Use plural argumentos para la selección plural adecuada y select argumentos para la selección simple entre un conjunto fijo de opciones.

Los argType valores y argStyle se usan para crear una Format instancia del elemento de formato. En la tabla siguiente se muestra cómo los valores se asignan a instancias de formato. Las combinaciones que no se muestran en la tabla son ilegales. Cualquiera argStyleText debe ser una cadena de patrón válida para la subclase Format usada.

<table border=1><tr><th>argType <th>argStyle <th>resultante Object <tr td><colspan=2>(none)<td>null<tr><td rowspan=5>number<td>(none)<td>NumberFormat.getInstance(getLocale())<tr td tr><>integer<>NumberFormat.getIntegerInstance(getLocale())<td td><td>currency<>NumberFormat.getCurrencyInstance(getLocale())<tr td tr td td tr><>percent<>NumberFormat.getPercentInstance(getLocale())<><td>argStyleText<td>new DecimalFormat(argStyleText, new DecimalFormatSymbols(getLocale()))<tr td><rowspan=6>date<td>(none)<td>DateFormat.getDateInstance(DateFormat.DEFAULT, getLocale())<tr><td td>short<>DateFormat.getDateInstance(DateFormat.SHORT, getLocale())<tr><td>medium<td>DateFormat.getDateInstance(DateFormat.DEFAULT, getLocale())<tr><td td>long<>DateFormat.getDateInstance(DateFormat.LONG, getLocale())<tr td tr><td td>full<tr td>DateFormat.getDateInstance(DateFormat.FULL, getLocale())<tr td td>< argStyleText><td>new SimpleDateFormat(argStyleText, getLocale())<tr><td rowspan=6>time<td>(none)<td>DateFormat.getTimeInstance(DateFormat.DEFAULT, getLocale())<tr td><>short<>trDateFormat.getTimeInstance(DateFormat.SHORT, getLocale())<td td><>medium<tr td>DateFormat.getTimeInstance(DateFormat.DEFAULT, getLocale())<tr><>long<td td>DateFormat.getTimeInstance(DateFormat.LONG, getLocale())<tr><td td>full<tr td>DateFormat.getTimeInstance(DateFormat.FULL, getLocale())<tr><td> argStyleText <td tr>new SimpleDateFormat(argStyleText, getLocale())<><td td>spellout<>argStyleText (optional)<td>new RuleBasedNumberFormat(getLocale(), RuleBasedNumberFormat.SPELLOUT) <br>&nbsp;&nbsp;&nbsp;&nbsp;.setDefaultRuleset(argStyleText);<tr><td td>ordinal<>argStyleText (optional)<td>new RuleBasedNumberFormat(getLocale(), RuleBasedNumberFormat.ORDINAL) <br>&nbsp;&nbsp;&nbsp;&nbsp;.setDefaultRuleset(argStyleText);<tr><td td>duration<>argStyleText (optional)<td>new RuleBasedNumberFormat(getLocale(), RuleBasedNumberFormat.DURATION) <br>&nbsp;&nbsp;&nbsp;&nbsp;.setDefaultRuleset(argStyleText);</table>

<h4>"diffsjdk">Diferencias de java.text.MessageFormat</h4>

MessageFormat de ICU admite argumentos con nombre y numerados, mientras que el MessageFormat de JDK solo admite argumentos numerados. Los argumentos con nombre hacen que los patrones sean más legibles.

ICU implementa una sintaxis de comillas apóstrofo más fáciles de usar. En el texto del mensaje, un apóstrofo solo comienza a citar texto literal si precede inmediatamente a un carácter de sintaxis (principalmente {llaves}).<br> En el JDK MessageFormat, un apóstrofo siempre comienza a citar, lo que requiere texto común como "don't" y "aujourd'hui" para escribirse con apóstrofos duplicados como "don't" y "aujourd''hui". Para obtener más información, consulte MessagePattern.ApostropheMode.

ICU no crea un objeto ChoiceFormat para choiceArg, pluralArg o selectArg, sino que controla dichos argumentos. El objeto MessageFormat de JDK crea y usa un objeto ChoiceFormat (new ChoiceFormat(argStyleText)). El JDK no admite argumentos plurales y select.

<h4>Información de uso</h4>

Estos son algunos ejemplos de uso: <blockquote>

Object[] arguments = {
                7,
                new Date(System.currentTimeMillis()),
                "a disturbance in the Force"
            };

            String result = MessageFormat.format(
                "At {1,time} on {1,date}, there was {2} on planet {0,number,integer}.",
                arguments);

<em>output</em>: At 12:30 PM on Jul 3, 2053, there was a disturbance
                      in the Force on planet 7.

</blockquote> Normalmente, el formato del mensaje procede de los recursos y los argumentos se establecerán dinámicamente en tiempo de ejecución.

Ejemplo 2: <blockquote>

Object[] testArgs = { 3, "MyDisk" };

            MessageFormat form = new MessageFormat(
                "The disk \"{1}\" contains {0} file(s).");

            System.out.println(form.format(testArgs));

            // output, with different testArgs
<em>output</em>: The disk "MyDisk" contains 0 file(s).
<em>output</em>: The disk "MyDisk" contains 1 file(s).
<em>output</em>: The disk "MyDisk" contains 1,273 file(s).

</blockquote>

Para los mensajes que incluyen formularios plurales, puede usar un argumento plural:

MessageFormat msgFmt = new MessageFormat(
                "{num_files, plural, " +
                "=0{There are no files on disk \"{disk_name}\".}" +
                "=1{There is one file on disk \"{disk_name}\".}" +
                "other{There are # files on disk \"{disk_name}\".}}",
                ULocale.ENGLISH);
            Map args = new HashMap();
            args.put("num_files", 0);
            args.put("disk_name", "MyDisk");
            System.out.println(msgFmt.format(args));
            args.put("num_files", 3);
            System.out.println(msgFmt.format(args));

<em>output</em>:
            There are no files on disk "MyDisk".
            There are 3 files on "MyDisk".

Consulte PluralFormat y PluralRules para obtener más información.

<h4>"synchronization">Synchronization</h4>

MessageFormats no están sincronizados. Se recomienda crear instancias de formato independientes para cada subproceso. Si varios subprocesos acceden a un formato simultáneamente, debe sincronizarse externamente.

Java documentación para android.icu.text.MessageFormat.

Las partes de esta página son modificaciones basadas en el trabajo creado y compartido por el Android y se usan según los términos descritos en creative Creative Commons 2.5 Attribution License.