com.google.template.soy.msgs.internal

Class SoyMsgIdComputer

java.lang.Object

com.google.template.soy.msgs.internal.SoyMsgIdComputer

public class SoyMsgIdComputer
extends Object

Static methods to compute the unique message id for a message.

Method Summary

Modifier and Type	Method and Description
static long	computeMsgId(com.google.common.collect.ImmutableList<SoyMsgPart> msgParts, String meaning, String contentType) Computes the unique message id for a message, given the message parts, the meaning string (if any), and the content type (if any).
static long	computeMsgIdUsingBracedPhs(com.google.common.collect.ImmutableList<SoyMsgPart> msgParts, String meaning, String contentType) Computes an alternate unique message id for a message, given the message parts, the meaning string (if any), and the content type (if any).

Methods inherited from class java.lang.Object

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

Method Detail

computeMsgId

public static long computeMsgId(com.google.common.collect.ImmutableList<SoyMsgPart> msgParts,
                                @Nullable
                                String meaning,
                                @Nullable
                                String contentType)

Computes the unique message id for a message, given the message parts, the meaning string (if any), and the content type (if any). These are the only elements incorporated into the message id.

In particular, note that the id of a message does not change when its desc changes.

Parameters:

msgParts - The parts of the message.

meaning - The meaning string, or null if none (usually null).

contentType - Content type of the document that this message will appear in (e.g. "text/html", or null if not used.

Returns:

The computed message id.

computeMsgIdUsingBracedPhs

public static long computeMsgIdUsingBracedPhs(com.google.common.collect.ImmutableList<SoyMsgPart> msgParts,
                                              @Nullable
                                              String meaning,
                                              @Nullable
                                              String contentType)

Computes an alternate unique message id for a message, given the message parts, the meaning string (if any), and the content type (if any). These are the only elements incorporated into the message id.

In particular, note that the id of a message does not change when its desc changes.

Important: This is an alternate message id computation using braced placeholders. Only use this function instead of computeMsgId(com.google.common.collect.ImmutableList<com.google.template.soy.msgs.restricted.SoyMsgPart>, java.lang.String, java.lang.String) if you know that you need this alternate format.

Parameters:

msgParts - The parts of the message.

meaning - The meaning string, or null if none (usually null).

contentType - Content type of the document that this message will appear in (e.g. "text/html", or null if not used..

Returns:

The computed message id.