mcs/class/RabbitMQ.Client/src/apigen/AmqpEntity.cs

   1 // This source code is dual-licensed under the Apache License, version
   2 // 2.0, and the Mozilla Public License, version 1.1.
   3 //
   4 // The APL v2.0:
   5 //
   6 //---------------------------------------------------------------------------
   7 //   Copyright (C) 2007-2009 LShift Ltd., Cohesive Financial
   8 //   Technologies LLC., and Rabbit Technologies Ltd.
   9 //
  10 //   Licensed under the Apache License, Version 2.0 (the "License");
  11 //   you may not use this file except in compliance with the License.
  12 //   You may obtain a copy of the License at
  13 //
  14 //       http://www.apache.org/licenses/LICENSE-2.0
  15 //
  16 //   Unless required by applicable law or agreed to in writing, software
  17 //   distributed under the License is distributed on an "AS IS" BASIS,
  18 //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19 //   See the License for the specific language governing permissions and
  20 //   limitations under the License.
  21 //---------------------------------------------------------------------------
  22 //
  23 // The MPL v1.1:
  24 //
  25 //---------------------------------------------------------------------------
  26 //   The contents of this file are subject to the Mozilla Public License
  27 //   Version 1.1 (the "License"); you may not use this file except in
  28 //   compliance with the License. You may obtain a copy of the License at
  29 //   http://www.rabbitmq.com/mpl.html
  30 //
  31 //   Software distributed under the License is distributed on an "AS IS"
  32 //   basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
  33 //   License for the specific language governing rights and limitations
  34 //   under the License.
  35 //
  36 //   The Original Code is The RabbitMQ .NET Client.
  37 //
  38 //   The Initial Developers of the Original Code are LShift Ltd,
  39 //   Cohesive Financial Technologies LLC, and Rabbit Technologies Ltd.
  40 //
  41 //   Portions created before 22-Nov-2008 00:00:00 GMT by LShift Ltd,
  42 //   Cohesive Financial Technologies LLC, or Rabbit Technologies Ltd
  43 //   are Copyright (C) 2007-2008 LShift Ltd, Cohesive Financial
  44 //   Technologies LLC, and Rabbit Technologies Ltd.
  45 //
  46 //   Portions created by LShift Ltd are Copyright (C) 2007-2009 LShift
  47 //   Ltd. Portions created by Cohesive Financial Technologies LLC are
  48 //   Copyright (C) 2007-2009 Cohesive Financial Technologies
  49 //   LLC. Portions created by Rabbit Technologies Ltd are Copyright
  50 //   (C) 2007-2009 Rabbit Technologies Ltd.
  51 //
  52 //   All Rights Reserved.
  53 //
  54 //   Contributor(s): ______________________________________.
  55 //
  56 //---------------------------------------------------------------------------
  57 using System;
  58 using System.Xml;
  59
  60 namespace RabbitMQ.Client.Apigen {
  61     public class AmqpEntity {
  62         public XmlNode m_node;
  63
  64         public AmqpEntity(XmlNode n) {
  65             m_node = n;
  66         }
  67
  68         public string GetString(string path) {
  69             return Apigen.GetString(m_node, path);
  70         }
  71
  72         public string GetString(string path, string d) {
  73             return Apigen.GetString(m_node, path, d);
  74         }
  75
  76         public int GetInt(string path) {
  77             return Apigen.GetInt(m_node, path);
  78         }
  79
  80         public string Name {
  81             get {
  82                 return GetString("@name");
  83             }
  84         }
  85
  86         public string DocumentationComment(string prefixSpaces) {
  87             return DocumentationComment(prefixSpaces, "doc");
  88         }
  89
  90         public string DocumentationCommentVariant(string prefixSpaces, string tagname) {
  91             return DocumentationComment(prefixSpaces, "doc", tagname);
  92         }
  93
  94         public string DocumentationComment(string prefixSpaces, string docXpath) {
  95             return DocumentationComment(prefixSpaces, docXpath, "summary");
  96         }
  97
  98         public string DocumentationComment(string prefixSpaces, string docXpath, string tagname) {
  99             string docStr = GetString(docXpath, "").Trim();
 100             if (docStr.Length > 0) {
 101                 return (prefixSpaces + "/// <"+tagname+">\n" +
 102                         GetString(docXpath, "") + "\n</"+tagname+">")
 103                     .Replace("\n", "\n" + prefixSpaces + "/// ");
 104             } else {
 105                 return prefixSpaces + "// (no documentation)";
 106             }
 107         }
 108     }
 109 }