MessageFormat.Field
Stay organized with collections
Save and categorize content based on your preferences.
Defines constants that are used as attribute keys in the
AttributedCharacterIterator
returned
from MessageFormat.formatToCharacterIterator
.
Field Summary
public
static
final
MessageFormat.Field |
ARGUMENT |
Constant identifying a portion of a message that was generated
from an argument passed into formatToCharacterIterator . |
Protected Constructor Summary
|
Field( String name)
Creates a Field with the specified name.
|
Protected Method Summary
Object
|
readResolve()
Resolves instances being deserialized to the predefined constants.
|
Inherited Method Summary
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this Object .
|
boolean
|
equals( Object obj)
Compares this instance with the specified object and indicates if they
are equal.
|
void
|
finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
|
final
Class<?>
|
getClass()
Returns the unique instance of Class that represents this
object's class.
|
int
|
hashCode()
Returns an integer hash code for this object.
|
final
void
|
notify()
Causes a thread which is waiting on this object's monitor (by means of
calling one of the wait() methods) to be woken up.
|
final
void
|
notifyAll()
Causes all threads which are waiting on this object's monitor (by means
of calling one of the wait() methods) to be woken up.
|
String
|
toString()
Returns a string containing a concise, human-readable description of this
object.
|
final
void
|
wait(long timeout, int nanos)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
final
void
|
wait(long timeout)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
final
void
|
wait()
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.
|
Fields
Constant identifying a portion of a message that was generated
from an argument passed into formatToCharacterIterator
.
The value associated with the key will be an Integer
indicating the index in the arguments
array of the
argument from which the text was generated.
Protected Constructors
protected
Field
(String name)
Creates a Field with the specified name.
Parameters
name |
Name of the attribute
|
Protected Methods
protected
Object
readResolve
()
Resolves instances being deserialized to the predefined constants.
Returns
- resolved MessageFormat.Field constant
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-07-10 UTC."],[[["\u003cp\u003e\u003ccode\u003eMessageFormat.Field\u003c/code\u003e defines constants used as attribute keys in the \u003ccode\u003eAttributedCharacterIterator\u003c/code\u003e returned from \u003ccode\u003eMessageFormat.formatToCharacterIterator\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThese constants identify portions of a message generated from arguments passed into \u003ccode\u003eformatToCharacterIterator\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eARGUMENT\u003c/code\u003e field specifically indicates the index of the argument in the \u003ccode\u003earguments\u003c/code\u003e array.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eMessageFormat.Field\u003c/code\u003e inherits from \u003ccode\u003eFormat.Field\u003c/code\u003e and provides methods for deserialization and resolving instances to predefined constants.\u003c/p\u003e\n"]]],[],null,["# MessageFormat.Field\n\npublic static class **MessageFormat.Field** extends [Format.Field](../../../reference/java/text/Format.Field.html) \nDefines constants that are used as attribute keys in the\n`AttributedCharacterIterator` returned\nfrom `MessageFormat.formatToCharacterIterator`. \n\n### Field Summary\n\n|--------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|\n| public static final [MessageFormat.Field](../../../reference/java/text/MessageFormat.Field.html) | [ARGUMENT](../../../reference/java/text/MessageFormat.Field.html#ARGUMENT) | Constant identifying a portion of a message that was generated from an argument passed into `formatToCharacterIterator`. |\n\n### Inherited Field Summary\n\nFrom class [java.text.AttributedCharacterIterator.Attribute](../../../reference/java/text/AttributedCharacterIterator.Attribute.html) \n\n|--------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|----------------------------------------------|\n| public static final [AttributedCharacterIterator.Attribute](../../../reference/java/text/AttributedCharacterIterator.Attribute.html) | [INPUT_METHOD_SEGMENT](../../../reference/java/text/AttributedCharacterIterator.Attribute.html#INPUT_METHOD_SEGMENT) | Attribute key for input method segments. |\n| public static final [AttributedCharacterIterator.Attribute](../../../reference/java/text/AttributedCharacterIterator.Attribute.html) | [LANGUAGE](../../../reference/java/text/AttributedCharacterIterator.Attribute.html#LANGUAGE) | Attribute key for the language of some text. |\n| public static final [AttributedCharacterIterator.Attribute](../../../reference/java/text/AttributedCharacterIterator.Attribute.html) | [READING](../../../reference/java/text/AttributedCharacterIterator.Attribute.html#READING) | Attribute key for the reading of some text. |\n\n### Protected Constructor Summary\n\n|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| | [Field](../../../reference/java/text/MessageFormat.Field.html#Field(java.lang.String))([String](../../../reference/java/lang/String.html) name) Creates a Field with the specified name. |\n\n### Protected Method Summary\n\n|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Object](../../../reference/java/lang/Object.html) | [readResolve](../../../reference/java/text/MessageFormat.Field.html#readResolve())() Resolves instances being deserialized to the predefined constants. |\n\n### Inherited Method Summary\n\nFrom class [java.text.AttributedCharacterIterator.Attribute](../../../reference/java/text/AttributedCharacterIterator.Attribute.html) \n\n|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| final boolean | [equals](../../../reference/java/text/AttributedCharacterIterator.Attribute.html#equals(java.lang.Object))([Object](../../../reference/java/lang/Object.html) obj) Compares two objects for equality. |\n| [String](../../../reference/java/lang/String.html) | [getName](../../../reference/java/text/AttributedCharacterIterator.Attribute.html#getName())() Returns the name of the attribute. |\n| final int | [hashCode](../../../reference/java/text/AttributedCharacterIterator.Attribute.html#hashCode())() Returns a hash code value for the object. |\n| [Object](../../../reference/java/lang/Object.html) | [readResolve](../../../reference/java/text/AttributedCharacterIterator.Attribute.html#readResolve())() Resolves instances being deserialized to the predefined constants. |\n| [String](../../../reference/java/lang/String.html) | [toString](../../../reference/java/text/AttributedCharacterIterator.Attribute.html#toString())() Returns a string representation of the object. |\n\nFrom class [java.lang.Object](../../../reference/java/lang/Object.html) \n\n|-------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Object](../../../reference/java/lang/Object.html) | [clone](../../../reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |\n| boolean | [equals](../../../reference/java/lang/Object.html#equals(java.lang.Object))([Object](../../../reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |\n| void | [finalize](../../../reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |\n| final [Class](../../../reference/java/lang/Class.html)\\\u003c?\\\u003e | [getClass](../../../reference/java/lang/Object.html#getClass())() Returns the unique instance of [Class](../../../reference/java/lang/Class.html) that represents this object's class. |\n| int | [hashCode](../../../reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |\n| final void | [notify](../../../reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |\n| final void | [notifyAll](../../../reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |\n| [String](../../../reference/java/lang/String.html) | [toString](../../../reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |\n| final void | [wait](../../../reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |\n| final void | [wait](../../../reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |\n| final void | [wait](../../../reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |\n\nFields\n------\n\n#### public static final MessageFormat.Field\n**ARGUMENT**\n\nConstant identifying a portion of a message that was generated\nfrom an argument passed into `formatToCharacterIterator`.\nThe value associated with the key will be an `Integer`\nindicating the index in the `arguments` array of the\nargument from which the text was generated.\n\nProtected Constructors\n----------------------\n\n#### protected\n**Field**\n([String](../../../reference/java/lang/String.html) name)\n\nCreates a Field with the specified name. \n\n##### Parameters\n\n| name | Name of the attribute |\n|------|-----------------------|\n\nProtected Methods\n-----------------\n\n#### protected [Object](../../../reference/java/lang/Object.html)\n**readResolve**\n()\n\nResolves instances being deserialized to the predefined constants. \n\n##### Returns\n\n- resolved MessageFormat.Field constant \n\n##### Throws\n\n| [InvalidObjectException](../../../reference/java/io/InvalidObjectException.html) | if the constant could not be resolved. |\n|----------------------------------------------------------------------------------|----------------------------------------|"]]