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

http://github.com/tomahawk-player/tomahawk · Java · 72 lines · 6 code · 5 blank · 61 comment · 0 complexity · 23889088e27f51654e7363a8a9600ee3 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.List;
  32. /**
  33. * An interface extending List<String> that also provides access to the
  34. * items of the list as UTF8-encoded ByteString objects. This is used by the
  35. * protocol buffer implementation to support lazily converting bytes parsed
  36. * over the wire to String objects until needed and also increases the
  37. * efficiency of serialization if the String was never requested as the
  38. * ByteString is already cached.
  39. * <p>
  40. * This only adds additional methods that are required for the use in the
  41. * protocol buffer code in order to be able successfuly round trip byte arrays
  42. * through parsing and serialization without conversion to strings. It's not
  43. * attempting to support the functionality of say List&ltByteString&gt, hence
  44. * why only these two very specific methods are added.
  45. *
  46. * @author jonp@google.com (Jon Perlow)
  47. */
  48. public interface LazyStringList extends List<String> {
  49. /**
  50. * Returns the element at the specified position in this list as a ByteString.
  51. *
  52. * @param index index of the element to return
  53. * @return the element at the specified position in this list
  54. * @throws IndexOutOfBoundsException if the index is out of range
  55. * (<tt>index &lt; 0 || index &gt;= size()</tt>)
  56. */
  57. ByteString getByteString(int index);
  58. /**
  59. * Appends the specified element to the end of this list (optional
  60. * operation).
  61. *
  62. * @param element element to be appended to this list
  63. * @throws UnsupportedOperationException if the <tt>add</tt> operation
  64. * is not supported by this list
  65. */
  66. void add(ByteString element);
  67. }