C# Класс URSA.Web.Http.Description.DescriptionContext

Provides a description context.
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
BuildTypeDescription ( ) : IClass

Builds the type description.
BuildTypeDescription ( bool &requiresRdf ) : IClass

Builds the type description.
ContainsType ( Type type ) : bool

Determines whether the given type is already described and available in the context.
Describe ( IClass resource, bool requiresRdf ) : void

Describes the current type.
IsTypeComplete ( Type type ) : bool

Determines whether the type described in the context is complete.
Prescribe ( IClass resource, bool requiresRdf ) : void

Prescribes the current type as being still under construction.
RequiresRdf ( Type type ) : bool

Checks whether the given type requires an RDF approach.
SubClass ( IClass @class, Type contextTypeOverride = null ) : IClass

Creates a sub-class of the given class.
this ( Type type ) : IClass

Gets the description for given type.

Приватные методы

Метод Описание
DescriptionContext ( IApiDocumentation apiDocumentation, ITypeDescriptionBuilder typeDescriptionBuilder, Type type, IDictionary typeDefinitions ) : System
ForType ( IApiDocumentation apiDocumentation, Type type, ITypeDescriptionBuilder typeDescriptionBuilder ) : DescriptionContext
ForType ( Type type ) : DescriptionContext

Описание методов

BuildTypeDescription() публичный Метод

Builds the type description.
public BuildTypeDescription ( ) : IClass
Результат IClass

BuildTypeDescription() публичный Метод

Builds the type description.
public BuildTypeDescription ( bool &requiresRdf ) : IClass
requiresRdf bool Flag determining whether the context's type requires an RDF approach.
Результат IClass

ContainsType() публичный Метод

Determines whether the given type is already described and available in the context.
public ContainsType ( Type type ) : bool
type System.Type The type to check for existence.
Результат bool

Describe() публичный Метод

Describes the current type.
public Describe ( IClass resource, bool requiresRdf ) : void
resource IClass The resource describing a type.
requiresRdf bool Flag determining whether the type requires RDF approach.
Результат void

IsTypeComplete() публичный Метод

Determines whether the type described in the context is complete.
public IsTypeComplete ( Type type ) : bool
type System.Type The type to check for completion.
Результат bool

Prescribe() публичный Метод

Prescribes the current type as being still under construction.
public Prescribe ( IClass resource, bool requiresRdf ) : void
resource IClass The resource describing a type.
requiresRdf bool Flag determining whether the type requires RDF approach.
Результат void

RequiresRdf() публичный Метод

Checks whether the given type requires an RDF approach.
public RequiresRdf ( Type type ) : bool
type System.Type The type to check.
Результат bool

SubClass() публичный Метод

Creates a sub-class of the given class.
public SubClass ( IClass @class, Type contextTypeOverride = null ) : IClass
@class IClass
contextTypeOverride System.Type The type that should override the one in this context.
Результат IClass

this() публичный Метод

Gets the description for given type.
public this ( Type type ) : IClass
type System.Type The type for which to obtain the description.
Результат IClass