C# Class URSA.Web.Http.Description.DescriptionContext

Provides a description context.
Show file Open project: alien-mcl/URSA Class Usage Examples

Public Methods

Method Description
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.

Private Methods

Method Description
DescriptionContext ( IApiDocumentation apiDocumentation, ITypeDescriptionBuilder typeDescriptionBuilder, Type type, IDictionary typeDefinitions ) : System
ForType ( IApiDocumentation apiDocumentation, Type type, ITypeDescriptionBuilder typeDescriptionBuilder ) : DescriptionContext
ForType ( Type type ) : DescriptionContext

Method Details

BuildTypeDescription() public method

Builds the type description.
public BuildTypeDescription ( ) : IClass
return IClass

BuildTypeDescription() public method

Builds the type description.
public BuildTypeDescription ( bool &requiresRdf ) : IClass
requiresRdf bool Flag determining whether the context's type requires an RDF approach.
return IClass

ContainsType() public method

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.
return bool

Describe() public method

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.
return void

IsTypeComplete() public method

Determines whether the type described in the context is complete.
public IsTypeComplete ( Type type ) : bool
type System.Type The type to check for completion.
return bool

Prescribe() public method

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.
return void

RequiresRdf() public method

Checks whether the given type requires an RDF approach.
public RequiresRdf ( Type type ) : bool
type System.Type The type to check.
return bool

SubClass() public method

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.
return IClass

this() public method

Gets the description for given type.
public this ( Type type ) : IClass
type System.Type The type for which to obtain the description.
return IClass