aboutsummaryrefslogtreecommitdiff
path: root/csharp/ProtocolBuffers/Descriptors/DescriptorValidationException.cs
blob: 62c723f354fd136b15dc2bb22a99d27522cfc1ba (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc.
// http://code.google.com/p/protobuf/
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
using System;

namespace Google.ProtocolBuffers.Descriptors {
  /// <summary>
  /// Thrown when building descriptors fails because the source DescriptorProtos
  /// are not valid.
  /// </summary>
  public sealed class DescriptorValidationException : Exception {

    private readonly String name;
    private readonly IMessage proto;
    private readonly string description;

    /// <value>
    /// The full name of the descriptor where the error occurred.
    /// </value>
    public String ProblemSymbolName { 
      get { return name; }
    }

    /// <value>
    /// The protocol message representation of the invalid descriptor.
    /// </value>
    public IMessage ProblemProto {
      get { return proto; }
    }

    /// <value>
    /// A human-readable description of the error. (The Message property
    /// is made up of the descriptor's name and this description.)
    /// </value>
    public string Description {
      get { return description; }
    }

    internal DescriptorValidationException(IDescriptor problemDescriptor, string description) :
        base(problemDescriptor.FullName + ": " + description) {

      // Note that problemDescriptor may be partially uninitialized, so we
      // don't want to expose it directly to the user.  So, we only provide
      // the name and the original proto.
      name = problemDescriptor.FullName;
      proto = problemDescriptor.Proto;
      this.description = description;
    }

    internal DescriptorValidationException(IDescriptor problemDescriptor, string description, Exception cause) :
        base(problemDescriptor.FullName + ": " + description, cause) {

      name = problemDescriptor.FullName;
      proto = problemDescriptor.Proto;
      this.description = description;
    }
  }
}