Free cookie consent management tool by TermsFeed Policy Generator

source: tags/3.3.4/HeuristicLab.ExtLibs/HeuristicLab.ProtobufCS/0.9.1/ProtobufCS/src/ProtocolBuffers/MessageUtil.cs

Last change on this file was 3857, checked in by abeham, 14 years ago

#866

  • Added protobuf-csharp-port project source to ExtLibs
File size: 4.7 KB
Line 
1#region Copyright notice and license
2// Protocol Buffers - Google's data interchange format
3// Copyright 2008 Google Inc.  All rights reserved.
4// http://github.com/jskeet/dotnet-protobufs/
5// Original C++/Java/Python code:
6// http://code.google.com/p/protobuf/
7//
8// Redistribution and use in source and binary forms, with or without
9// modification, are permitted provided that the following conditions are
10// met:
11//
12//     * Redistributions of source code must retain the above copyright
13// notice, this list of conditions and the following disclaimer.
14//     * Redistributions in binary form must reproduce the above
15// copyright notice, this list of conditions and the following disclaimer
16// in the documentation and/or other materials provided with the
17// distribution.
18//     * Neither the name of Google Inc. nor the names of its
19// contributors may be used to endorse or promote products derived from
20// this software without specific prior written permission.
21//
22// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33#endregion
34
35using System;
36using System.Reflection;
37
38namespace Google.ProtocolBuffers {
39  /// <summary>
40  /// Utilities for arbitrary messages of an unknown type. This class does not use
41  /// generics precisely because it is designed for dynamically discovered types.
42  /// </summary>
43  public static class MessageUtil {
44
45    /// <summary>
46    /// Returns the default message for the given type. If an exception is thrown
47    /// (directly from this code), the message will be suitable to be displayed to a user.
48    /// </summary>
49    /// <param name="type"></param>
50    /// <exception cref="ArgumentNullException">The type parameter is null.</exception>
51    /// <exception cref="ArgumentException">The type doesn't implement IMessage, or doesn't
52    /// have a static DefaultMessage property of the same type, or is generic or abstract.</exception>
53    /// <returns></returns>
54    public static IMessage GetDefaultMessage(Type type) {
55      if (type == null) {
56        throw new ArgumentNullException("type", "No type specified.");
57      }
58      if (type.IsAbstract || type.IsGenericTypeDefinition) {
59        throw new ArgumentException("Unable to get a default message for an abstract or generic type (" + type.FullName + ")");
60      }
61      if (!typeof(IMessage).IsAssignableFrom(type)) {
62        throw new ArgumentException("Unable to get a default message for non-message type (" + type.FullName + ")");
63      }
64      PropertyInfo property = type.GetProperty("DefaultInstance", BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic);
65      if (property == null) {
66        throw new ArgumentException(type.FullName + " doesn't have a static DefaultInstance property");
67      }
68      if (property.PropertyType != type) {
69        throw new ArgumentException(type.FullName + ".DefaultInstance property is of the wrong type");
70      }
71      return (IMessage) property.GetValue(null, null);
72    }
73
74    /// <summary>
75    /// Returns the default message for the type with the given name. This is just
76    /// a convenience wrapper around calling Type.GetType and then GetDefaultMessage.
77    /// If an exception is thrown, the message will be suitable to be displayed to a user.
78    /// </summary>
79    /// <param name="typeName"></param>
80    /// <exception cref="ArgumentNullException">The typeName parameter is null.</exception>
81    /// <exception cref="ArgumentException">The type doesn't implement IMessage, or doesn't
82    /// have a static DefaultMessage property of the same type, or can't be found.</exception>
83    public static IMessage GetDefaultMessage(string typeName) {
84      if (typeName == null) {
85        throw new ArgumentNullException("typeName", "No type name specified.");
86      }
87      Type type = Type.GetType(typeName);
88      if (type == null) {
89        throw new ArgumentException("Unable to load type " + typeName);
90      }
91      return GetDefaultMessage(type);
92    }
93  }
94}
Note: See TracBrowser for help on using the repository browser.