java_names.h 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. // Protocol Buffers - Google's data interchange format
  2. // Copyright 2008 Google Inc. All rights reserved.
  3. // https://developers.google.com/protocol-buffers/
  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. // Author: kenton@google.com (Kenton Varda)
  31. // Based on original Protocol Buffers design by
  32. // Sanjay Ghemawat, Jeff Dean, and others.
  33. //
  34. // Provides a mechanism for mapping a descriptor to the
  35. // fully-qualified name of the corresponding Java class.
  36. #ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_NAMES_H__
  37. #define GOOGLE_PROTOBUF_COMPILER_JAVA_NAMES_H__
  38. #include <string>
  39. namespace google {
  40. namespace protobuf {
  41. class Descriptor;
  42. class EnumDescriptor;
  43. class FileDescriptor;
  44. class FieldDescriptor;
  45. class ServiceDescriptor;
  46. namespace compiler {
  47. namespace java {
  48. // Requires:
  49. // descriptor != NULL
  50. //
  51. // Returns:
  52. // The fully-qualified Java class name.
  53. std::string ClassName(const Descriptor* descriptor);
  54. // Requires:
  55. // descriptor != NULL
  56. //
  57. // Returns:
  58. // The fully-qualified Java class name.
  59. std::string ClassName(const EnumDescriptor* descriptor);
  60. // Requires:
  61. // descriptor != NULL
  62. //
  63. // Returns:
  64. // The fully-qualified Java class name.
  65. std::string ClassName(const FileDescriptor* descriptor);
  66. // Requires:
  67. // descriptor != NULL
  68. //
  69. // Returns:
  70. // The fully-qualified Java class name.
  71. std::string ClassName(const ServiceDescriptor* descriptor);
  72. // Requires:
  73. // descriptor != NULL
  74. //
  75. // Returns:
  76. // Java package name.
  77. std::string FileJavaPackage(const FileDescriptor* descriptor);
  78. // Requires:
  79. // descriptor != NULL
  80. // Returns:
  81. // Capitalized camel case name field name.
  82. std::string CapitalizedFieldName(const FieldDescriptor* descriptor);
  83. } // namespace java
  84. } // namespace compiler
  85. } // namespace protobuf
  86. } // namespace google
  87. #endif // GOOGLE_PROTOBUF_COMPILER_JAVA_NAMES_H__