1 // Protocol Buffers - Google's data interchange format
2 // Copyright 2008 Google Inc. All rights reserved.
3 // https://developers.google.com/protocol-buffers/
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 // * Redistributions in binary form must reproduce the above
12 // copyright notice, this list of conditions and the following disclaimer
13 // in the documentation and/or other materials provided with the
15 // * Neither the name of Google Inc. nor the names of its
16 // contributors may be used to endorse or promote products derived from
17 // this software without specific prior written permission.
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 package com.google.protobuf;
33 import java.io.IOException;
36 * Thrown when a protocol message being parsed is invalid in some way,
37 * e.g. it contains a malformed varint or a negative byte length.
39 * @author kenton@google.com Kenton Varda
41 public class InvalidProtocolBufferException extends IOException {
42 private static final long serialVersionUID = -1616151763072450476L;
43 private MessageLite unfinishedMessage = null;
45 public InvalidProtocolBufferException(final String description) {
50 * Attaches an unfinished message to the exception to support best-effort
51 * parsing in {@code Parser} interface.
55 public InvalidProtocolBufferException setUnfinishedMessage(
56 MessageLite unfinishedMessage) {
57 this.unfinishedMessage = unfinishedMessage;
62 * Returns the unfinished message attached to the exception, or null if
63 * no message is attached.
65 public MessageLite getUnfinishedMessage() {
66 return unfinishedMessage;
69 static InvalidProtocolBufferException truncatedMessage() {
70 return new InvalidProtocolBufferException(
71 "While parsing a protocol message, the input ended unexpectedly " +
72 "in the middle of a field. This could mean either than the " +
73 "input has been truncated or that an embedded message " +
74 "misreported its own length.");
77 static InvalidProtocolBufferException negativeSize() {
78 return new InvalidProtocolBufferException(
79 "CodedInputStream encountered an embedded string or message " +
80 "which claimed to have negative size.");
83 static InvalidProtocolBufferException malformedVarint() {
84 return new InvalidProtocolBufferException(
85 "CodedInputStream encountered a malformed varint.");
88 static InvalidProtocolBufferException invalidTag() {
89 return new InvalidProtocolBufferException(
90 "Protocol message contained an invalid tag (zero).");
93 static InvalidProtocolBufferException invalidEndTag() {
94 return new InvalidProtocolBufferException(
95 "Protocol message end-group tag did not match expected tag.");
98 static InvalidProtocolBufferException invalidWireType() {
99 return new InvalidProtocolBufferException(
100 "Protocol message tag had invalid wire type.");
103 static InvalidProtocolBufferException recursionLimitExceeded() {
104 return new InvalidProtocolBufferException(
105 "Protocol message had too many levels of nesting. May be malicious. " +
106 "Use CodedInputStream.setRecursionLimit() to increase the depth limit.");
109 static InvalidProtocolBufferException sizeLimitExceeded() {
110 return new InvalidProtocolBufferException(
111 "Protocol message was too large. May be malicious. " +
112 "Use CodedInputStream.setSizeLimit() to increase the size limit.");
115 static InvalidProtocolBufferException parseFailure() {
116 return new InvalidProtocolBufferException("Failed to parse the message.");
119 static InvalidProtocolBufferException invalidUtf8() {
120 return new InvalidProtocolBufferException("Protocol message had invalid UTF-8.");