File: Documentation.cs

package info (click to toggle)
mono 6.14.1%2Bds2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,282,732 kB
  • sloc: cs: 11,182,461; xml: 2,850,281; ansic: 699,123; cpp: 122,919; perl: 58,604; javascript: 30,841; asm: 21,845; makefile: 19,602; sh: 10,973; python: 4,772; pascal: 925; sql: 859; sed: 16; php: 1
file content (128 lines) | stat: -rw-r--r-- 3,327 bytes parent folder | download | duplicates (6)
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
//---------------------------------------------------------------------
// <copyright file="Documentation.cs" company="Microsoft">
//      Copyright (c) Microsoft Corporation.  All rights reserved.
// </copyright>
//
// @owner       Microsoft
// @backupOwner Microsoft
//---------------------------------------------------------------------

using System;
using System.Collections.Generic;
using System.Data.Common;
using System.Diagnostics;
using System.Globalization;
using System.Text;
using System.Data.Common.Utils;

namespace System.Data.Metadata.Edm
{
    /// <summary>
    /// Class representing the Documentation associated with an item
    /// </summary>
    public sealed class Documentation: MetadataItem
    {
        #region Fields
        private string _summary = "";
        private string _longDescription = "";
        #endregion

        #region Constructors
        /// <summary>
        /// Default constructor - primarily created for supporting usage of this Documentation class by SOM.
        /// </summary>
        internal Documentation()
        {
        }        
        #endregion
       
        #region Properties

        /// <summary>
        /// Returns the kind of the type
        /// </summary>
        public override BuiltInTypeKind BuiltInTypeKind { get { return BuiltInTypeKind.Documentation; } }

        /// <summary>
        /// Gets the Summary for this Documentation instance.
        /// </summary>
        /// 
        public string Summary
        {
            get
            {
                return _summary;
            }
            internal set
            {
                if (value != null)
                    _summary = value;
                else
                    _summary = "";
            }
        }

        /// <summary>
        /// Gets the LongDescription for this Documentation instance.
        /// </summary>
        /// 
        public string LongDescription
        {
            get
            {
                return _longDescription;
            }
            internal set
            {
                if (value != null)
                    _longDescription = value;
                else
                    _longDescription = "";
            }
        }


        /// <summary>
        /// This property is required to be implemented for inheriting from MetadataItem. As there can be atmost one
        /// instance of a nested-Documentation, return the constant "Documentation" as it's identity.
        /// </summary>
        internal override string Identity
        {
            get
            {
                return "Documentation";
            }
        }

        /// <summary>
        /// Returns true if this Documentation instance contains only null/empty summary and longDescription
        /// </summary>
        /// 
        public bool IsEmpty
        {
            get
            {
                if (string.IsNullOrEmpty(_summary) && string.IsNullOrEmpty(_longDescription) )
                {
                    return true;
                }

                return false;
            }
        }


        #endregion
        
        #region Methods

        /// <summary>
        /// </summary>
        public override string ToString()
        {
            return _summary;
        }

        #endregion
    }
}