A DocCommand based on a Catalog

Introduced properties

private var _catalog: Catalog

nitc :: CmdCatalog :: _catalog

Catalog to query at

fun catalog: Catalog

nitc :: CmdCatalog :: catalog

Catalog to query at

protected fun catalog=(catalog: Catalog)

nitc :: CmdCatalog :: catalog=

Catalog to query at

init defaultinit(model: Model, catalog: Catalog, filter: nullable ModelFilter)

nitc :: CmdCatalog :: defaultinit

Redefined properties

redef type SELF: CmdCatalog

nitc $ CmdCatalog :: SELF

Type of this instance, automatically specialized in every class

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?

fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?

type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.

type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class

private var _catalog: Catalog

nitc :: CmdCatalog :: _catalog

Catalog to query at

private var _filter: nullable ModelFilter

nitc :: DocCommand :: _filter

ModelFilter to apply if any

private var _model: Model

nitc :: DocCommand :: _model

Model to retrieve data for

fun catalog: Catalog

nitc :: CmdCatalog :: catalog

Catalog to query at

protected fun catalog=(catalog: Catalog)

nitc :: CmdCatalog :: catalog=

Catalog to query at

protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.

fun class_name: String

core :: Object :: class_name

The class name of the object.

fun cmd_filter: ModelFilter

nitc :: DocCommand :: cmd_filter

Return a new filter for that command execution.

init defaultinit

core :: Object :: defaultinit

init defaultinit(model: Model, filter: nullable ModelFilter)

nitc :: DocCommand :: defaultinit

init defaultinit(model: Model, catalog: Catalog, filter: nullable ModelFilter)

nitc :: CmdCatalog :: defaultinit

abstract fun execute(no_color: nullable Bool)

nitc :: DocCommand :: execute

fun filter: nullable ModelFilter

nitc :: DocCommand :: filter

ModelFilter to apply if any

protected fun filter=(filter: nullable ModelFilter)

nitc :: DocCommand :: filter=

ModelFilter to apply if any

fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.

fun hash: Int

core :: Object :: hash

The hash code of the object.

fun http_init(req: HttpRequest): CmdMessage

nitc :: DocCommand :: http_init

Init the command from an HTTPRequest

init init

core :: Object :: init

fun init_command: CmdMessage

nitc :: DocCommand :: init_command

Initialize the command

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.

protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".

intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).

fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?

intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.

fun model: Model

nitc :: DocCommand :: model

Model to retrieve data for

protected fun model=(model: Model)

nitc :: DocCommand :: model=

Model to retrieve data for

private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.

intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.

fun output

core :: Object :: output

Display self on stdout (debug only).

intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).

fun parser_init(arg: String, options: CmdOptions): CmdMessage

nitc :: DocCommand :: parser_init

Initialize the command from the CommandParser data

fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization

intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.

fun to_html: Writable

nitc :: DocCommand :: to_html

Render results as a HTML string

abstract fun to_json: nullable Serializable

nitc :: DocCommand :: to_json

Return a JSON Serializable representation of self results

abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_md: Writable

nitc :: DocCommand :: to_md

Render results as a Markdown string

fun to_s: String

core :: Object :: to_s

User readable representation of self.

Ancestors

interface Object

The root of the class hierarchy.

Parents

abstract class DocCommand

nitc :: DocCommand

Documentation command

Children

class CmdCatalogPackages

nitc :: CmdCatalogPackages

Retrieve the packages in the catalog

class CmdCatalogPerson

nitc :: CmdCatalogPerson

Retrieve a person from the catalog

class CmdCatalogSearch

nitc :: CmdCatalogSearch

A CmdSearch command using a Catalog

class CmdCatalogStats

nitc :: CmdCatalogStats

Retrieve the catalog stats

class CmdCatalogTags

nitc :: CmdCatalogTags

Retrieve the catalog tags list

Descendants

class CmdCatalogContributing

nitc :: CmdCatalogContributing

Retrieve the packages contributed by a person

class CmdCatalogMaintaining

nitc :: CmdCatalogMaintaining

Retrieve the packages maintained by a person

class CmdCatalogTag

nitc :: CmdCatalogTag

Retrieve the packages for a tag

Class definitions

nitc $ CmdCatalog

# A DocCommand based on a Catalog
abstract class CmdCatalog
	super DocCommand

	autoinit(model, catalog, filter)

	# Catalog to query at
	var catalog: Catalog
end

src/doc/commands/commands_catalog.nit:21,1--29,3