public final class JsMessage
extends java.lang.Object
Instances are created using a JsMessage.Builder
,
like this:
JsMessage m = new JsMessage.Builder(key) .appendPart("Hi ") .appendPlaceholderReference("firstName") .appendPart("!") .setDesc("A welcome message") .build();
Modifier and Type | Class and Description |
---|---|
static class |
JsMessage.Builder
Contains functionality for creating JS messages.
|
(package private) static class |
JsMessage.Hash
This class contains routines for hashing.
|
static interface |
JsMessage.IdGenerator
ID generator
|
static class |
JsMessage.PlaceholderReference
A reference to a placeholder in a translatable message.
|
static class |
JsMessage.Style
Message style that could be used for JS code parsing.
|
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
desc |
private boolean |
hidden |
private java.lang.String |
id |
private boolean |
isAnonymous |
private boolean |
isExternal |
private java.lang.String |
key |
private java.lang.String |
meaning |
private static java.lang.String |
MESSAGE_REPRESENTATION_FORMAT |
private java.util.List<java.lang.CharSequence> |
parts |
private java.util.Set<java.lang.String> |
placeholders |
private java.lang.String |
sourceName |
Modifier | Constructor and Description |
---|---|
private |
JsMessage(java.lang.String sourceName,
java.lang.String key,
boolean isAnonymous,
boolean isExternal,
java.lang.String id,
java.util.List<java.lang.CharSequence> parts,
java.util.Set<java.lang.String> placeholders,
java.lang.String desc,
boolean hidden,
java.lang.String meaning)
Creates an instance.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object o) |
java.lang.String |
getDesc()
Gets the description associated with this message, intended to help
translators, or null if this message has no description.
|
java.lang.String |
getId()
Gets the message's id, or name (e.g.
|
java.lang.String |
getKey()
Gets the message's key, or name (e.g.
|
(package private) java.lang.String |
getMeaning()
Gets the meaning annotated to the message, intended to force different
translations.
|
java.lang.String |
getSourceName()
Gets the message's sourceName.
|
int |
hashCode() |
boolean |
isAnonymous() |
boolean |
isEmpty() |
boolean |
isExternal() |
boolean |
isHidden()
Gets whether this message should be hidden from volunteer translators (to
reduce the chances of a new feature leak).
|
java.util.List<java.lang.CharSequence> |
parts()
Gets a read-only list of the parts of this message.
|
java.util.Set<java.lang.String> |
placeholders()
Gets a read-only set of the registered placeholders in this message.
|
java.lang.String |
toString() |
private static final java.lang.String MESSAGE_REPRESENTATION_FORMAT
private final java.lang.String key
private final java.lang.String id
private final java.util.List<java.lang.CharSequence> parts
private final java.util.Set<java.lang.String> placeholders
private final java.lang.String desc
private final boolean hidden
private final java.lang.String meaning
private final java.lang.String sourceName
private final boolean isAnonymous
private final boolean isExternal
private JsMessage(java.lang.String sourceName, java.lang.String key, boolean isAnonymous, boolean isExternal, java.lang.String id, java.util.List<java.lang.CharSequence> parts, java.util.Set<java.lang.String> placeholders, java.lang.String desc, boolean hidden, java.lang.String meaning)
JsMessage.Builder
.key
- a key that should identify this message in sources; typically
it is the message's name (e.g. "MSG_HELLO"
).id
- an id that *uniquely* identifies the message in the bundle.
It could be either the message name or id generated from the message
content.meaning
- The user-specified meaning of the message. May be null if
the user did not specify an explicit meaning.public java.lang.String getSourceName()
public java.lang.String getKey()
"MSG_HELLO"
).public boolean isAnonymous()
public boolean isExternal()
public java.lang.String getId()
"92430284230902938293"
).public java.lang.String getDesc()
java.lang.String getMeaning()
public boolean isHidden()
public java.util.List<java.lang.CharSequence> parts()
String
or a JsMessage.PlaceholderReference
.public java.util.Set<java.lang.String> placeholders()
public java.lang.String toString()
toString
in class java.lang.Object
public boolean isEmpty()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object