class CmdDescendants

nitc :: CmdDescendants

MEntity descendants command

Introduced properties

private var _children: Bool

nitc :: CmdDescendants :: _children

Include direct children in the descendants list
fun children: Bool

nitc :: CmdDescendants :: children

Include direct children in the descendants list
fun children=(children: nullable Bool)

nitc :: CmdDescendants :: children=

Include direct children in the descendants list
init defaultinit(model: Model, mainmodule: MModule, filter: nullable ModelFilter, mentity: nullable MEntity, mentity_name: nullable String, limit: nullable Int, page: nullable Int, count: nullable Int, max: nullable Int, children: nullable Bool)

nitc :: CmdDescendants :: defaultinit

Redefined properties

redef type SELF: CmdDescendants

nitc $ CmdDescendants :: SELF

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

nitc :: term $ CmdDescendants :: execute

redef fun http_init(req: HttpRequest): CmdMessage

nitc :: commands_http $ CmdDescendants :: http_init

Init the command from an HTTPRequest
redef fun init_results: CmdMessage

nitc $ CmdDescendants :: init_results

Initialize the results list
redef fun parser_init(mentity_name: String, options: CmdOptions): CmdMessage

nitc :: commands_parser $ CmdDescendants :: parser_init

Initialize the command from the CommandParser data
redef fun to_html: Writable

nitc :: html_commands $ CmdDescendants :: to_html

Render results as a HTML string
redef fun to_md: Writable

nitc :: md_commands $ CmdDescendants :: 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 _children: Bool

nitc :: CmdDescendants :: _children

Include direct children in the descendants list
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 _mainmodule: MModule

nitc :: CmdInheritance :: _mainmodule

Mainmodule for class linearization
private var _max: nullable Int

nitc :: CmdList :: _max

Total number of pages
private var _mentity: nullable MEntity

nitc :: CmdEntity :: _mentity

MEntity this command is about
private var _mentity_name: nullable String

nitc :: CmdEntity :: _mentity_name

Name of the mentity this command is about
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
fun children: Bool

nitc :: CmdDescendants :: children

Include direct children in the descendants list
fun children=(children: nullable Bool)

nitc :: CmdDescendants :: children=

Include direct children in the descendants 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, mentity: nullable MEntity, mentity_name: nullable String)

nitc :: CmdEntity :: defaultinit

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

nitc :: CmdEntityList :: defaultinit

init defaultinit(model: Model, mainmodule: MModule, filter: nullable ModelFilter, mentity: nullable MEntity, mentity_name: nullable String, limit: nullable Int, page: nullable Int, count: nullable Int, max: nullable Int, children: nullable Bool)

nitc :: CmdDescendants :: defaultinit

init defaultinit(model: Model, mainmodule: MModule, filter: nullable ModelFilter, mentity: nullable MEntity, mentity_name: nullable String, limit: nullable Int, page: nullable Int, count: nullable Int, max: nullable Int)

nitc :: CmdInheritance :: defaultinit

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

nitc :: DocCommand :: defaultinit

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

nitc :: CmdEntities :: defaultinit

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

nitc :: CmdList :: 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_mentity: CmdMessage

nitc :: CmdEntity :: init_mentity

Initialize the command mentity.
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 mainmodule: MModule

nitc :: CmdInheritance :: mainmodule

Mainmodule for class linearization
protected fun mainmodule=(mainmodule: MModule)

nitc :: CmdInheritance :: mainmodule=

Mainmodule for class linearization
fun max: nullable Int

nitc :: CmdList :: max

Total number of pages
fun max=(max: nullable Int)

nitc :: CmdList :: max=

Total number of pages
fun mentity: nullable MEntity

nitc :: CmdEntity :: mentity

MEntity this command is about
fun mentity=(mentity: nullable MEntity)

nitc :: CmdEntity :: mentity=

MEntity this command is about
fun mentity_name: nullable String

nitc :: CmdEntity :: mentity_name

Name of the mentity this command is about
fun mentity_name=(mentity_name: nullable String)

nitc :: CmdEntity :: mentity_name=

Name of the mentity this command is about
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.
package_diagram nitc::CmdDescendants CmdDescendants nitc::CmdInheritance CmdInheritance nitc::CmdDescendants->nitc::CmdInheritance nitc::CmdEntityList CmdEntityList nitc::CmdInheritance->nitc::CmdEntityList ...nitc::CmdEntityList ... ...nitc::CmdEntityList->nitc::CmdEntityList

Ancestors

abstract class CmdEntities

nitc :: CmdEntities

A list of mentities
class CmdEntity

nitc :: CmdEntity

A command about a MEntity
abstract class CmdEntityList

nitc :: CmdEntityList

A command about a MEntity that returns a list of mentities
abstract class CmdList

nitc :: CmdList

A command that returns a list of results
abstract class DocCommand

nitc :: DocCommand

Documentation command
interface Object

core :: Object

The root of the class hierarchy.

Parents

abstract class CmdInheritance

nitc :: CmdInheritance

An abstract inheritance command

Class definitions

nitc $ CmdDescendants 
# MEntity descendants command
class CmdDescendants
	super CmdInheritance

	# Include direct children in the descendants list
	#
	# Default is `true`.
	var children = true is optional, writable

	redef fun init_results do
		if results != null then return new CmdSuccess

		var res = super
		if not res isa CmdSuccess then return res
		var mentity = self.mentity.as(not null)

		var descendants = mentity.collect_descendants(mainmodule, filter).to_a
		if children then
			results = descendants
			return res
		end

		var children = mentity.collect_children(mainmodule, filter)
		var mentities = new HashSet[MEntity]
		for descendant in descendants do
			if not children.has(descendant) then mentities.add descendant
		end
		results = mentities.to_a
		return res
	end
end
src/doc/commands/commands_model.nit:193,1--223,3

nitc :: commands_parser $ CmdDescendants 
redef class CmdDescendants
	redef fun parser_init(mentity_name, options) do
		var opt_children = options.opt_bool("no-children")
		if opt_children != null then children = not opt_children
		return super
	end
end
src/doc/commands/commands_parser.nit:348,1--354,3

nitc :: md_commands $ CmdDescendants 
redef class CmdDescendants
	redef fun to_md do return super # FIXME lin
end
src/doc/templates/md_commands.nit:149,1--151,3

nitc :: commands_http $ CmdDescendants 
redef class CmdDescendants
	redef fun http_init(req) do
		var opt_children = req.bool_arg("children")
		if opt_children != null then children = opt_children
		return super
	end
end
src/doc/commands/commands_http.nit:139,1--145,3

nitc :: term $ CmdDescendants 
redef class CmdDescendants
	redef fun execute(no_color) do
		var full_name = mentity.as(not null).cs_full_name(no_color)
		print_list("Descendants for `{full_name}`:", results, no_color)
	end
end
src/doc/term/term.nit:176,1--181,3

nitc :: html_commands $ CmdDescendants 
redef class CmdDescendants
	redef fun to_html do return super # FIXME lin
end
src/doc/templates/html_commands.nit:176,1--178,3
Nit tools. Version v0.8-3595-g3f58b4f.