1 #region Copyright notice and license 2 // Protocol Buffers - Google's data interchange format 3 // Copyright 2015 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 35 namespace Google.Protobuf 36 { 37 /// <summary> 38 /// Generic interface for a Protocol Buffers message containing one or more extensions, where the type parameter is expected to be the same type as the implementation class. 39 /// This interface is experiemental and is subject to change. 40 /// </summary> 41 public interface IExtendableMessage<T> : IMessage<T> where T : IExtendableMessage<T> 42 { 43 /// <summary> 44 /// Gets the value of the specified extension 45 /// </summary> GetExtension(Extension<T, TValue> extension)46 TValue GetExtension<TValue>(Extension<T, TValue> extension); 47 48 /// <summary> 49 /// Gets the value of the specified repeated extension or null if the extension isn't registered in this set. 50 /// For a version of this method that never returns null, use <see cref="IExtendableMessage{T}.GetOrInitializeExtension{TValue}(RepeatedExtension{T, TValue})"/> 51 /// </summary> GetExtension(RepeatedExtension<T, TValue> extension)52 RepeatedField<TValue> GetExtension<TValue>(RepeatedExtension<T, TValue> extension); 53 54 /// <summary> 55 /// Gets the value of the specified repeated extension, registering it if it hasn't already been registered. 56 /// </summary> GetOrInitializeExtension(RepeatedExtension<T, TValue> extension)57 RepeatedField<TValue> GetOrInitializeExtension<TValue>(RepeatedExtension<T, TValue> extension); 58 59 /// <summary> 60 /// Sets the value of the specified extension 61 /// </summary> SetExtension(Extension<T, TValue> extension, TValue value)62 void SetExtension<TValue>(Extension<T, TValue> extension, TValue value); 63 64 /// <summary> 65 /// Gets whether the value of the specified extension is set 66 /// </summary> HasExtension(Extension<T, TValue> extension)67 bool HasExtension<TValue>(Extension<T, TValue> extension); 68 69 /// <summary> 70 /// Clears the value of the specified extension 71 /// </summary> ClearExtension(Extension<T, TValue> extension)72 void ClearExtension<TValue>(Extension<T, TValue> extension); 73 74 /// <summary> 75 /// Clears the value of the specified repeated extension 76 /// </summary> ClearExtension(RepeatedExtension<T, TValue> extension)77 void ClearExtension<TValue>(RepeatedExtension<T, TValue> extension); 78 } 79 } 80