A list of mentities

Introduced properties

private var _sorter: nullable Comparator

nitc :: CmdEntities :: _sorter

init defaultinit(model: Model, filter: nullable ModelFilter, limit: nullable Int, page: nullable Int, count: nullable Int, max: nullable Int)

nitc :: CmdEntities :: defaultinit

Redefined properties

redef type ITEM: MEntity

nitc $ CmdEntities :: ITEM

Type of result

redef type SELF: CmdEntities

nitc $ CmdEntities :: SELF

Type of this instance, automatically specialized in every class

redef fun sorter: nullable Comparator

nitc $ CmdEntities :: sorter

Comparator used to sort the list

redef fun sorter=(sorter: nullable Comparator)

nitc $ CmdEntities :: sorter=

Comparator used to sort the list

redef fun to_html: Writable

nitc :: html_commands $ CmdEntities :: to_html

Render results as a HTML string

redef fun to_md: Writable

nitc :: md_commands $ CmdEntities :: to_md

Render results as a Markdown string

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 ITEM: Object

nitc :: CmdList :: ITEM

Type of result

type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class

private var _count: nullable Int

nitc :: CmdList :: _count

Total number of ret

private var _filter: nullable ModelFilter

nitc :: DocCommand :: _filter

ModelFilter to apply if any

private var _limit: nullable Int

nitc :: CmdList :: _limit

Limit the items in the list

private var _max: nullable Int

nitc :: CmdList :: _max

Total number of pages

private var _model: Model

nitc :: DocCommand :: _model

Model to retrieve data for

private var _page: nullable Int

nitc :: CmdList :: _page

Page to display

private var _results: nullable Array[ITEM]

nitc :: CmdList :: _results

Items in the list

private var _sorter: nullable Comparator

nitc :: CmdEntities :: _sorter

private var _sorter: nullable Comparator

nitc :: CmdList :: _sorter

Comparator used to sort the list

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.

fun count: nullable Int

nitc :: CmdList :: count

Total number of ret

fun count=(count: nullable Int)

nitc :: CmdList :: count=

Total number of ret

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

nitc :: DocCommand :: defaultinit

init defaultinit

core :: Object :: defaultinit

init defaultinit(model: Model, filter: nullable ModelFilter, limit: nullable Int, page: nullable Int, count: nullable Int, max: nullable Int)

nitc :: CmdList :: defaultinit

init defaultinit(model: Model, filter: nullable ModelFilter, limit: nullable Int, page: nullable Int, count: nullable Int, max: nullable Int)

nitc :: CmdEntities :: 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 init_results: CmdMessage

nitc :: CmdList :: init_results

Initialize the results list

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 limit: nullable Int

nitc :: CmdList :: limit

Limit the items in the list

fun limit=(limit: nullable Int)

nitc :: CmdList :: limit=

Limit the items in the list

fun max: nullable Int

nitc :: CmdList :: max

Total number of pages

fun max=(max: nullable Int)

nitc :: CmdList :: max=

Total number of pages

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 page: nullable Int

nitc :: CmdList :: page

Page to display

fun page=(page: nullable Int)

nitc :: CmdList :: page=

Page to display

fun paginate

nitc :: CmdList :: paginate

Paginate the results

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

nitc :: DocCommand :: parser_init

Initialize the command from the CommandParser data

fun print_list(list_title: nullable String, list_items: nullable Array[MEntity], no_color: nullable Bool)

nitc :: CmdList :: print_list

fun results: nullable Array[ITEM]

nitc :: CmdList :: results

Items in the list

fun results=(results: nullable Array[ITEM])

nitc :: CmdList :: results=

Items in the list

fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization

fun sort

nitc :: CmdList :: sort

Sort mentities with sorter

fun sorter: nullable Comparator

nitc :: CmdList :: sorter

Comparator used to sort the list

fun sorter=(sorter: nullable Comparator)

nitc :: CmdList :: sorter=

Comparator used to sort the list

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

abstract class DocCommand

nitc :: DocCommand

Documentation command

interface Object

core :: Object

The root of the class hierarchy.

Parents

abstract class CmdList

nitc :: CmdList

A command that returns a list of results

Children

class CmdCatalogPackages

nitc :: CmdCatalogPackages

Retrieve the packages in the catalog

abstract class CmdEntityList

nitc :: CmdEntityList

A command about a MEntity that returns a list of mentities

class CmdModelEntities

nitc :: CmdModelEntities

A command that returns a list of all mentities in a model

class CmdSearch

nitc :: CmdSearch

A free text search command

Descendants

class CmdAllProps

nitc :: CmdAllProps

TODO remove once the filters/sorters are merged

class CmdAncestors

nitc :: CmdAncestors

MEntity ancestors command

class CmdCall

nitc :: CmdCall

Retrieve all the mproperties that call mentity

class CmdCatalogContributing

nitc :: CmdCatalogContributing

Retrieve the packages contributed by a person

class CmdCatalogMaintaining

nitc :: CmdCatalogMaintaining

Retrieve the packages maintained by a person

class CmdCatalogSearch

nitc :: CmdCatalogSearch

A CmdSearch command using a Catalog

class CmdCatalogTag

nitc :: CmdCatalogTag

Retrieve the packages for a tag

class CmdChildren

nitc :: CmdChildren

MEntity children command

class CmdDescendants

nitc :: CmdDescendants

MEntity descendants command

class CmdFeatures

nitc :: CmdFeatures

MEntity feature list

abstract class CmdInheritance

nitc :: CmdInheritance

An abstract inheritance command

class CmdIntros

nitc :: CmdIntros

TODO remove once the filters/sorters are merged

class CmdLinearization

nitc :: CmdLinearization

Linearization command

class CmdMains

nitc :: CmdMains

Cmd that finds the mains of an mentity

class CmdNew

nitc :: CmdNew

Retrieve all the mproperties that initialize mentity

class CmdParam

nitc :: CmdParam

Retrieve all the mproperties using mentity as a type for its parameters

class CmdParents

nitc :: CmdParents

MEntity parents command

class CmdRandomEntities

nitc :: CmdRandomEntities

A command that returns a random list of mentities from a model

class CmdRedefs

nitc :: CmdRedefs

TODO remove once the filters/sorters are merged

class CmdReturn

nitc :: CmdReturn

Retrieve all the mproperties that return somethinf of the mentity type.

class CmdTesting

nitc :: CmdTesting

Cmd that finds the nitunit command related to an mentity

Class definitions

nitc $ CmdEntities

# A list of mentities
abstract class CmdEntities
	super CmdList

	redef type ITEM: MEntity

	redef var sorter = new MEntityNameSorter
end

src/doc/commands/commands_base.nit:308,1--315,3

nitc :: md_commands $ CmdEntities

redef class CmdEntities
	redef fun to_md do
		var mentities = self.results
		if mentities == null then return ""

		var tpl = new Template
		for mentity in mentities do
			var mdoc = mentity.mdoc_or_fallback
			tpl.add "* `{mentity}`"
			if mdoc != null then
				tpl.add " - "
				tpl.add mdoc.synopsis
			end
			tpl.add "\n"
		end
		return tpl.write_to_string
	end
end

src/doc/templates/md_commands.nit:56,1--73,3

nitc :: html_commands $ CmdEntities

redef class CmdEntities
	redef fun to_html do
		var mentities = self.results
		if mentities == null then return ""

		var tpl = new Template
		tpl.add "<ul>"
		for mentity in mentities do
			var mdoc = mentity.mdoc_or_fallback
			tpl.add "<li>"
			tpl.add mentity.html_link
			if mdoc != null then
				tpl.add " - "
				tpl.add mdoc.html_synopsis
			end
			tpl.add "</li>"
		end
		tpl.add "</ul>"
		return tpl.write_to_string
	end
end

src/doc/templates/html_commands.nit:59,1--79,3

abstract class CmdEntities

Summary

A list of mentities

Introduced properties

_sorter

defaultinit

Redefined properties

ITEM

SELF

sorter

sorter=

to_html

to_md

A list of mentities

Introduced properties

private var _sorter: nullable Comparator

init defaultinit(model: Model, filter: nullable ModelFilter, limit: nullable Int, page: nullable Int, count: nullable Int, max: nullable Int)

Redefined properties

redef type ITEM: MEntity

redef type SELF: CmdEntities

redef fun sorter: nullable Comparator

redef fun sorter=(sorter: nullable Comparator)

redef fun to_html: Writable

redef fun to_md: Writable

Summary

All properties

!=

==

CLASS

ITEM

SELF

_count

_filter

_limit

_max

_model

_page

_results

_sorter

_sorter

class_factory

class_name

cmd_filter

count

count=

defaultinit

defaultinit

defaultinit

defaultinit

execute

filter

filter=

get_class

hash

http_init

init

init_command

init_results

inspect

inspect_head

is_same_instance

is_same_serialized

is_same_type

limit

limit=

max

max=

model

model=

native_class_name

object_id

output

output_class_name

page

page=

paginate

parser_init

print_list

results

results=