/thirdparty/breakpad/third_party/protobuf/protobuf/java/src/main/java/com/google/protobuf/UninitializedMessageException.java

http://github.com/tomahawk-player/tomahawk · Java · 99 lines · 36 code · 9 blank · 54 comment · 3 complexity · ffe579b8482ba4898741073bc5aa47ae MD5 · raw file

  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. package com.google.protobuf;
  31. import java.util.Collections;
  32. import java.util.List;
  33. /**
  34. * Thrown when attempting to build a protocol message that is missing required
  35. * fields. This is a {@code RuntimeException} because it normally represents
  36. * a programming error: it happens when some code which constructs a message
  37. * fails to set all the fields. {@code parseFrom()} methods <b>do not</b>
  38. * throw this; they throw an {@link InvalidProtocolBufferException} if
  39. * required fields are missing, because it is not a programming error to
  40. * receive an incomplete message. In other words,
  41. * {@code UninitializedMessageException} should never be thrown by correct
  42. * code, but {@code InvalidProtocolBufferException} might be.
  43. *
  44. * @author kenton@google.com Kenton Varda
  45. */
  46. public class UninitializedMessageException extends RuntimeException {
  47. private static final long serialVersionUID = -7466929953374883507L;
  48. public UninitializedMessageException(final MessageLite message) {
  49. super("Message was missing required fields. (Lite runtime could not " +
  50. "determine which fields were missing).");
  51. missingFields = null;
  52. }
  53. public UninitializedMessageException(final List<String> missingFields) {
  54. super(buildDescription(missingFields));
  55. this.missingFields = missingFields;
  56. }
  57. private final List<String> missingFields;
  58. /**
  59. * Get a list of human-readable names of required fields missing from this
  60. * message. Each name is a full path to a field, e.g. "foo.bar[5].baz".
  61. * Returns null if the lite runtime was used, since it lacks the ability to
  62. * find missing fields.
  63. */
  64. public List<String> getMissingFields() {
  65. return Collections.unmodifiableList(missingFields);
  66. }
  67. /**
  68. * Converts this exception to an {@link InvalidProtocolBufferException}.
  69. * When a parsed message is missing required fields, this should be thrown
  70. * instead of {@code UninitializedMessageException}.
  71. */
  72. public InvalidProtocolBufferException asInvalidProtocolBufferException() {
  73. return new InvalidProtocolBufferException(getMessage());
  74. }
  75. /** Construct the description string for this exception. */
  76. private static String buildDescription(final List<String> missingFields) {
  77. final StringBuilder description =
  78. new StringBuilder("Message missing required fields: ");
  79. boolean first = true;
  80. for (final String field : missingFields) {
  81. if (first) {
  82. first = false;
  83. } else {
  84. description.append(", ");
  85. }
  86. description.append(field);
  87. }
  88. return description.toString();
  89. }
  90. }