InvalidProtocolBufferException.java revision fbaaef999ba563838ebd00874ed8a1c01fbf286d 
1// Protocol Buffers - Google's data interchange format
2// Copyright 2008 Google Inc.  All rights reserved.
3// http://code.google.com/p/protobuf/
4//
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions are
7// met:
8//
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
14// distribution.
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.
18//
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.
30
31package com.google.protobuf;
32
33import java.io.IOException;
34
35/**
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.
38 *
39 * @author kenton@google.com Kenton Varda
40 */
41public class InvalidProtocolBufferException extends IOException {
42  private static final long serialVersionUID = -1616151763072450476L;
43
44  public InvalidProtocolBufferException(final String description) {
45    super(description);
46  }
47
48  static InvalidProtocolBufferException truncatedMessage() {
49    return new InvalidProtocolBufferException(
50      "While parsing a protocol message, the input ended unexpectedly " +
51      "in the middle of a field.  This could mean either than the " +
52      "input has been truncated or that an embedded message " +
53      "misreported its own length.");
54  }
55
56  static InvalidProtocolBufferException negativeSize() {
57    return new InvalidProtocolBufferException(
58      "CodedInputStream encountered an embedded string or message " +
59      "which claimed to have negative size.");
60  }
61
62  static InvalidProtocolBufferException malformedVarint() {
63    return new InvalidProtocolBufferException(
64      "CodedInputStream encountered a malformed varint.");
65  }
66
67  static InvalidProtocolBufferException invalidTag() {
68    return new InvalidProtocolBufferException(
69      "Protocol message contained an invalid tag (zero).");
70  }
71
72  static InvalidProtocolBufferException invalidEndTag() {
73    return new InvalidProtocolBufferException(
74      "Protocol message end-group tag did not match expected tag.");
75  }
76
77  static InvalidProtocolBufferException invalidWireType() {
78    return new InvalidProtocolBufferException(
79      "Protocol message tag had invalid wire type.");
80  }
81
82  static InvalidProtocolBufferException recursionLimitExceeded() {
83    return new InvalidProtocolBufferException(
84      "Protocol message had too many levels of nesting.  May be malicious.  " +
85      "Use CodedInputStream.setRecursionLimit() to increase the depth limit.");
86  }
87
88  static InvalidProtocolBufferException sizeLimitExceeded() {
89    return new InvalidProtocolBufferException(
90      "Protocol message was too large.  May be malicious.  " +
91      "Use CodedInputStream.setSizeLimit() to increase the size limit.");
92  }
93}
94