class CmdCatalogStats

nitc :: CmdCatalogStats

Retrieve the catalog stats

Introduced properties

private var _stats: nullable CatalogStats

nitc :: CmdCatalogStats :: _stats

Retrieved catalog statistics
init defaultinit(model: Model, catalog: Catalog, filter: nullable ModelFilter, stats: nullable CatalogStats)

nitc :: CmdCatalogStats :: defaultinit

fun stats: nullable CatalogStats

nitc :: CmdCatalogStats :: stats

Retrieved catalog statistics
fun stats=(stats: nullable CatalogStats)

nitc :: CmdCatalogStats :: stats=

Retrieved catalog statistics

Redefined properties

redef type SELF: CmdCatalogStats

nitc $ CmdCatalogStats :: SELF

Type of this instance, automatically specialized in every class
redef fun execute(no_color: nullable Bool)

nitc :: term $ CmdCatalogStats :: execute

redef fun init_command: CmdMessage

nitc $ CmdCatalogStats :: init_command

Initialize the command
redef fun to_json: nullable Serializable

nitc :: json_commands $ CmdCatalogStats :: to_json

Return a JSON Serializable representation of self results

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
private var _stats: nullable CatalogStats

nitc :: CmdCatalogStats :: _stats

Retrieved catalog statistics
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(model: Model, catalog: Catalog, filter: nullable ModelFilter)

nitc :: CmdCatalog :: defaultinit

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

nitc :: CmdCatalogStats :: defaultinit

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

nitc :: DocCommand :: 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
fun stats: nullable CatalogStats

nitc :: CmdCatalogStats :: stats

Retrieved catalog statistics
fun stats=(stats: nullable CatalogStats)

nitc :: CmdCatalogStats :: stats=

Retrieved catalog statistics
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.
package_diagram nitc::CmdCatalogStats CmdCatalogStats nitc::CmdCatalog CmdCatalog nitc::CmdCatalogStats->nitc::CmdCatalog nitc::DocCommand DocCommand nitc::CmdCatalog->nitc::DocCommand ...nitc::DocCommand ... ...nitc::DocCommand->nitc::DocCommand

Ancestors

abstract class DocCommand

nitc :: DocCommand

Documentation command
interface Object

core :: Object

The root of the class hierarchy.

Parents

abstract class CmdCatalog

nitc :: CmdCatalog

A DocCommand based on a Catalog

Class definitions

nitc $ CmdCatalogStats 
# Retrieve the catalog stats
class CmdCatalogStats
	super CmdCatalog

	# Retrieved catalog statistics
	var stats: nullable CatalogStats = null is optional, writable

	redef fun init_command do
		super
		self.stats = catalog.catalog_stats
		return new CmdSuccess
	end
end
src/doc/commands/commands_catalog.nit:153,1--165,3

nitc :: json_commands $ CmdCatalogStats 
redef class CmdCatalogStats
	redef fun to_json do return stats
end
src/doc/templates/json_commands.nit:118,1--120,3

nitc :: term $ CmdCatalogStats 
redef class CmdCatalogStats
	redef fun execute(no_color) do
		if no_color == null or not no_color then
			print "Catalog statistics:".bold
		else
			print "Catalog statistics:"
		end

		var stats = self.stats.as(not null)
		print " * {stats.packages} packages"
		print " * {stats.modules} modules"
		print " * {stats.methods} methods"
		print " * {stats.classes} classes"
		print " * {stats.loc} lines of code"
		print " * {stats.contributors} contributors"
		print " * {stats.maintainers} maintainers"
		print " * {stats.tags} tags"
	end
end
src/doc/term/term.nit:287,1--305,3
Nit tools. Version .