1 #region Copyright notice and license 2 // Protocol Buffers - Google's data interchange format 3 // Copyright 2008 Google Inc. All rights reserved. 4 // https://developers.google.com/protocol-buffers/ 5 // 6 // Redistribution and use in source and binary forms, with or without 7 // modification, are permitted provided that the following conditions are 8 // met: 9 // 10 // * Redistributions of source code must retain the above copyright 11 // notice, this list of conditions and the following disclaimer. 12 // * Redistributions in binary form must reproduce the above 13 // copyright notice, this list of conditions and the following disclaimer 14 // in the documentation and/or other materials provided with the 15 // distribution. 16 // * Neither the name of Google Inc. nor the names of its 17 // contributors may be used to endorse or promote products derived from 18 // this software without specific prior written permission. 19 // 20 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 23 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 24 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 25 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 26 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 30 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 #endregion 32 33 using Google.Protobuf.Collections; 34 using System; 35 36 namespace Google.Protobuf.Reflection 37 { 38 /// <summary> 39 /// Descriptor for a single enum value within an enum in a .proto file. 40 /// </summary> 41 public sealed class EnumValueDescriptor : DescriptorBase 42 { 43 private readonly EnumDescriptor enumDescriptor; 44 private readonly EnumValueDescriptorProto proto; 45 EnumValueDescriptor(EnumValueDescriptorProto proto, FileDescriptor file, EnumDescriptor parent, int index)46 internal EnumValueDescriptor(EnumValueDescriptorProto proto, FileDescriptor file, 47 EnumDescriptor parent, int index) 48 : base(file, parent.FullName + "." + proto.Name, index) 49 { 50 this.proto = proto; 51 enumDescriptor = parent; 52 file.DescriptorPool.AddSymbol(this); 53 file.DescriptorPool.AddEnumValueByNumber(this); 54 } 55 56 internal EnumValueDescriptorProto Proto { get { return proto; } } 57 58 /// <summary> 59 /// Returns a clone of the underlying <see cref="EnumValueDescriptorProto"/> describing this enum value. 60 /// Note that a copy is taken every time this method is called, so clients using it frequently 61 /// (and not modifying it) may want to cache the returned value. 62 /// </summary> 63 /// <returns>A protobuf representation of this enum value descriptor.</returns> ToProto()64 public EnumValueDescriptorProto ToProto() => Proto.Clone(); 65 66 /// <summary> 67 /// Returns the name of the enum value described by this object. 68 /// </summary> 69 public override string Name { get { return proto.Name; } } 70 71 /// <summary> 72 /// Returns the number associated with this enum value. 73 /// </summary> 74 public int Number { get { return Proto.Number; } } 75 76 /// <summary> 77 /// Returns the enum descriptor that this value is part of. 78 /// </summary> 79 public EnumDescriptor EnumDescriptor { get { return enumDescriptor; } } 80 81 /// <summary> 82 /// The (possibly empty) set of custom options for this enum value. 83 /// </summary> 84 [Obsolete("CustomOptions are obsolete. Use the GetOptions() method.")] 85 public CustomOptions CustomOptions => new CustomOptions(Proto.Options?._extensions?.ValuesByNumber); 86 87 /// <summary> 88 /// The <c>EnumValueOptions</c>, defined in <c>descriptor.proto</c>. 89 /// If the options message is not present (i.e. there are no options), <c>null</c> is returned. 90 /// Custom options can be retrieved as extensions of the returned message. 91 /// NOTE: A defensive copy is created each time this property is retrieved. 92 /// </summary> GetOptions()93 public EnumValueOptions GetOptions() => Proto.Options?.Clone(); 94 95 /// <summary> 96 /// Gets a single value enum value option for this descriptor 97 /// </summary> 98 [Obsolete("GetOption is obsolete. Use the GetOptions() method.")] GetOption(Extension<EnumValueOptions, T> extension)99 public T GetOption<T>(Extension<EnumValueOptions, T> extension) 100 { 101 var value = Proto.Options.GetExtension(extension); 102 return value is IDeepCloneable<T> ? (value as IDeepCloneable<T>).Clone() : value; 103 } 104 105 /// <summary> 106 /// Gets a repeated value enum value option for this descriptor 107 /// </summary> 108 [Obsolete("GetOption is obsolete. Use the GetOptions() method.")] GetOption(RepeatedExtension<EnumValueOptions, T> extension)109 public RepeatedField<T> GetOption<T>(RepeatedExtension<EnumValueOptions, T> extension) 110 { 111 return Proto.Options.GetExtension(extension).Clone(); 112 } 113 } 114 } 115