Interface FormatMessageOrBuilder (1.21.0)

public interface FormatMessageOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFormat()

public abstract String getFormat()

Format template for the message. The format uses placeholders $0, $1, etc. to reference parameters. $$ can be used to denote the $ character.

Examples:

  • Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.
  • Please pay $$10 to use $0 instead of $1.

string format = 1;

Returns
TypeDescription
String

The format.

getFormatBytes()

public abstract ByteString getFormatBytes()

Format template for the message. The format uses placeholders $0, $1, etc. to reference parameters. $$ can be used to denote the $ character.

Examples:

  • Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.
  • Please pay $$10 to use $0 instead of $1.

string format = 1;

Returns
TypeDescription
ByteString

The bytes for format.

getParameters(int index)

public abstract String getParameters(int index)

Optional parameters to be embedded into the message.

repeated string parameters = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The parameters at the given index.

getParametersBytes(int index)

public abstract ByteString getParametersBytes(int index)

Optional parameters to be embedded into the message.

repeated string parameters = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the parameters at the given index.

getParametersCount()

public abstract int getParametersCount()

Optional parameters to be embedded into the message.

repeated string parameters = 2;

Returns
TypeDescription
int

The count of parameters.

getParametersList()

public abstract List<String> getParametersList()

Optional parameters to be embedded into the message.

repeated string parameters = 2;

Returns
TypeDescription
List<String>

A list containing the parameters.