Package com.google.protobuf.util

Class JsonFormat

java.lang.Object

com.google.protobuf.util.JsonFormat

public class JsonFormat
extends Object

Utility classes to convert protobuf messages to/from JSON format. The JSON format follows Proto3 JSON specification and only proto3 features are supported. Proto2 only features (e.g., extensions and unknown fields) will be discarded in the conversion. That is, when converting proto2 messages to JSON format, extensions and unknown fields will be treated as if they do not exist. This applies to proto2 messages embedded in proto3 messages as well.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	JsonFormat.CompactTextGenerator	Format the json without indentation
static class	JsonFormat.Parser	A Parser parses JSON to protobuf message.
private static class	JsonFormat.ParserImpl
private static final class	JsonFormat.PrettyTextGenerator	A TextGenerator adds indentation when writing formatted text.
static class	JsonFormat.Printer	A Printer converts protobuf message to JSON format.
private static final class	JsonFormat.PrinterImpl	A Printer converts protobuf messages to JSON format.
(package private) static interface	JsonFormat.TextGenerator	An interface for json formatting that can be used in combination with the omittingInsignificantWhitespace() method
static class	JsonFormat.TypeRegistry	A TypeRegistry is used to resolve Any messages in the JSON conversion.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Logger	logger

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JsonFormat()

Method Summary

Modifier and Type	Method	Description
private static String	getTypeName(String typeUrl)
static JsonFormat.Parser	parser()	Creates a JsonFormat.Parser with default configuration.
static JsonFormat.Printer	printer()	Creates a JsonFormat.Printer with default configurations.
private static String	unsignedToString(int value)	Convert an unsigned 32-bit integer to a string.
private static String	unsignedToString(long value)	Convert an unsigned 64-bit integer to a string.

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final Logger logger

Constructor Details

JsonFormat

private JsonFormat()

Method Details

printer

public static JsonFormat.Printer printer()

Creates a JsonFormat.Printer with default configurations.

parser

public static JsonFormat.Parser parser()

Creates a JsonFormat.Parser with default configuration.

unsignedToString

private static String unsignedToString(int value)

Convert an unsigned 32-bit integer to a string.

unsignedToString

private static String unsignedToString(long value)

Convert an unsigned 64-bit integer to a string.

getTypeName

private static String getTypeName(String typeUrl)
                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException