History

Pradeep Gollakota 4d98369f6d Allow custom URLs for Any in JsonFormat - Using custom URL for types in Any will no longer throw an InvalidProtocolBufferException in JsonFormat - Fixes #1128		2016-03-18 23:06:14 -07:00
..
core	Remove redundant `the` in comments.	2016-02-03 15:27:27 -08:00
lite	Integrate from google internal.	2016-01-29 13:51:05 -08:00
util	Allow custom URLs for Any in JsonFormat	2016-03-18 23:06:14 -07:00
pom.xml	Restructuring protobuf to multiple modules	2016-01-13 08:15:15 -08:00
README.md	rename python README, and fix markdown in java and python respectively	2015-03-16 15:15:59 -07:00

README.md

Protocol Buffers - Google's data interchange format

This directory contains the Java Protocol Buffers runtime library.

Installation - With Maven

The Protocol Buffers build is managed using Maven. If you would rather build without Maven, see below.

Install Apache Maven if you don't have it:

http://maven.apache.org/
Build the C++ code, or obtain a binary distribution of protoc. If you install a binary distribution, make sure that it is the same version as this package. If in doubt, run:

$ protoc --version

You will need to place the protoc executable in ../src. (If you built it yourself, it should already be there.)
Run the tests:

$ mvn test

If some tests fail, this library may not work correctly on your system. Continue at your own risk.
Install the library into your Maven repository:

$ mvn install
If you do not use Maven to manage your own build, you can build a .jar file to use:

$ mvn package

The .jar will be placed in the "target" directory.

Installation - 'Lite' Version - With Maven

Building the 'lite' version of the Java Protocol Buffers library is the same as building the full version, except that all commands are run using the 'lite' profile. (see http://maven.apache.org/guides/introduction/introduction-to-profiles.html)

E.g. to install the lite version of the jar, you would run:

$ mvn install -P lite

The resulting artifact has the 'lite' classifier. To reference it for dependency resolution, you would specify it as:

  <dependency>
    <groupId>com.google.protobuf</groupId>
    <artifactId>protobuf-java</artifactId>
    <version>${version}</version>
    <classifier>lite</classifier>
  </dependency>

Installation - Without Maven

If you would rather not install Maven to build the library, you may follow these instructions instead. Note that these instructions skip running unit tests.

Build the C++ code, or obtain a binary distribution of protoc. If you install a binary distribution, make sure that it is the same version as this package. If in doubt, run:

$ protoc --version

If you built the C++ code without installing, the compiler binary should be located in ../src.
Invoke protoc to build DescriptorProtos.java:

$ protoc --java_out=src/main/java -I../src
../src/google/protobuf/descriptor.proto
Compile the code in src/main/java using whatever means you prefer.
Install the classes wherever you prefer.

Usage

The complete documentation for Protocol Buffers is available via the web at:

https://developers.google.com/protocol-buffers/