class CommandHelp

nitc :: CommandHelp

Show general help or help specific to a command

Introduced properties

init defaultinit(all_commands: Map[String, Command])

nitc :: CommandHelp :: defaultinit

Redefined properties

redef type SELF: CommandHelp

nitc $ CommandHelp :: SELF

Type of this instance, automatically specialized in every class
redef fun apply(args: Array[String])

nitc $ CommandHelp :: apply

Apply this command consiering the args that follow
redef fun description: String

nitc $ CommandHelp :: description

Command description
redef fun name: String

nitc $ CommandHelp :: name

Short name of the command, specified in the command line
redef fun usage: String

nitc $ CommandHelp :: usage

Short usage description

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 fun all_commands=(all_commands: Map[String, Command])

nitc :: Command :: all_commands=

fun apply(args: Array[String])

nitc :: Command :: apply

Apply this command consiering the args that follow
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.
init defaultinit(all_commands: Map[String, Command])

nitc :: Command :: defaultinit

init defaultinit(all_commands: Map[String, Command])

nitc :: CommandHelp :: defaultinit

abstract fun description: String

nitc :: Command :: description

Command description
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.
init init

core :: Object :: init

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.
abstract fun name: String

nitc :: Command :: name

Short name of the command, specified in the command line
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 print_local_help

nitc :: Command :: print_local_help

Print the help message for this command
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.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
abstract fun usage: String

nitc :: Command :: usage

Short usage description
package_diagram nitc::CommandHelp CommandHelp nitc::Command Command nitc::CommandHelp->nitc::Command core::Object Object nitc::Command->core::Object ...core::Object ... ...core::Object->core::Object

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

abstract class Command

nitc :: Command

Command line action, passed after nitpm

Class definitions

nitc $ CommandHelp 
# Show general help or help specific to a command
class CommandHelp
	super Command

	redef fun name do return "help"
	redef fun usage do return "nitpm help [command]"
	redef fun description do return "Show general help message or the help for a command"

	redef fun apply(args)
	do
		# Try first to help about a valid action
		if args.length == 1 then
			var command = commands.get_or_null(args.first)
			if command != null then
				command.print_local_help
				return
			end
		end

		print_help
	end
end
src/nitpm.nit:344,1--365,3
Nit tools. Version .