Commands options

Introduced properties

private var _allowed_visibility: HashMap[String, MVisibility]

nitc :: CmdOptions :: _allowed_visibility

Map String visiblity name to MVisibility object
fun allowed_visibility: HashMap[String, MVisibility]

nitc :: CmdOptions :: allowed_visibility

Map String visiblity name to MVisibility object
protected fun allowed_visibility=(allowed_visibility: HashMap[String, MVisibility])

nitc :: CmdOptions :: allowed_visibility=

Map String visiblity name to MVisibility object
fun opt_bool(key: String): nullable Bool

nitc :: CmdOptions :: opt_bool

Get option value as bool
fun opt_int(key: String): nullable Int

nitc :: CmdOptions :: opt_int

Get option value for key as Int
private fun opt_mentity(model: Model, key: String): nullable MEntity

nitc :: CmdOptions :: opt_mentity

Get option as a MEntity
fun opt_string(key: String): nullable String

nitc :: CmdOptions :: opt_string

Get option value for key as String
fun opt_visibility(key: String): nullable MVisibility

nitc :: CmdOptions :: opt_visibility

Get option as a MVisibility

Redefined properties

redef type SELF: CmdOptions

nitc $ CmdOptions :: 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.
private type N: HashNode[K]

core :: HashCollection :: N

type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
abstract fun [](key: nullable Object): V

core :: MapRead :: []

Get the item at key
abstract fun []=(key: K, value: V)

core :: Map :: []=

Set the value at key.
private var _allowed_visibility: HashMap[String, MVisibility]

nitc :: CmdOptions :: _allowed_visibility

Map String visiblity name to MVisibility object
private var _array: NativeArray[nullable N]

core :: HashCollection :: _array

private var _capacity: Int

core :: HashCollection :: _capacity

private var _first_item: nullable N

core :: HashCollection :: _first_item

private var _keys: RemovableCollection[K]

core :: HashMap :: _keys

private var _last_accessed_key: nullable Object

core :: HashCollection :: _last_accessed_key

The last key accessed (used for cache)
private var _last_accessed_node: nullable N

core :: HashCollection :: _last_accessed_node

The last node accessed (used for cache)
private var _last_item: nullable N

core :: HashCollection :: _last_item

protected fun accept_json_serializer(v: JsonSerializer)

serialization :: Serializable :: accept_json_serializer

Refinable service to customize the serialization of this class to JSON
protected fun accept_msgpack_attribute_counter(v: AttributeCounter)

serialization :: Serializable :: accept_msgpack_attribute_counter

Hook to customize the behavior of the AttributeCounter
protected fun accept_msgpack_serializer(v: MsgPackSerializer)

serialization :: Serializable :: accept_msgpack_serializer

Hook to customize the serialization of this class to MessagePack
fun add_all(map: MapRead[K, V])

core :: Map :: add_all

Add each (key,value) of map into self.
protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according
fun allowed_visibility: HashMap[String, MVisibility]

nitc :: CmdOptions :: allowed_visibility

Map String visiblity name to MVisibility object
protected fun allowed_visibility=(allowed_visibility: HashMap[String, MVisibility])

nitc :: CmdOptions :: allowed_visibility=

Map String visiblity name to MVisibility object
private fun array: NativeArray[nullable N]

core :: HashCollection :: array

private fun array=(array: NativeArray[nullable N])

core :: HashCollection :: array=

private fun capacity: Int

core :: HashCollection :: capacity

private fun capacity=(capacity: Int)

core :: HashCollection :: capacity=

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.
abstract fun clear

core :: Map :: clear

Remove all items
fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
private fun enlarge(cap: Int)

core :: HashCollection :: enlarge

Force a capacity
fun filter_keys(keys: Collection[nullable Object]): Array[K]

core :: MapRead :: filter_keys

Return all elements of keys that have a value.
private fun first_item: nullable N

core :: HashCollection :: first_item

private fun first_item=(first_item: nullable N)

core :: HashCollection :: first_item=

init from(coll: Map[K, V])

core :: HashMap :: from

Build a list filled with the items of coll.
init from_deserializer(deserializer: Deserializer)

serialization :: Serializable :: from_deserializer

Create an instance of this class from the deserializer
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun get_or_default(key: nullable Object, default: V): V

core :: MapRead :: get_or_default

Get the item at key or return default if not in map
fun get_or_null(key: nullable Object): nullable V

core :: MapRead :: get_or_null

Get the item at key or null if key is not in the map.
private fun gt_collide(i: Int, k: K)

core :: HashCollection :: gt_collide

Count and update length of collisions for node_at_idx
fun has_key(key: nullable Object): Bool

core :: MapRead :: has_key

Is there an item associated with key?
fun hash: Int

core :: Object :: hash

The hash code of the object.
private fun index_at(k: nullable Object): Int

core :: HashCollection :: index_at

Return the index of the key k
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".
abstract fun is_empty: Bool

core :: MapRead :: is_empty

Is there no item in the collection?
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 iterator: MapIterator[K, V]

core :: MapRead :: iterator

Get a new iterator on the map.
abstract fun join(sep: String, couple_sep: String): String

core :: Map :: join

Concatenate couples of key value.
abstract fun keys: Collection[K]

core :: MapRead :: keys

Return the point of view of self on the keys only.
protected fun keys=(keys: RemovableCollection[K])

core :: HashMap :: keys=

fun keys_sorted_by_values(comparator: Comparator): Array[K]

core :: MapRead :: keys_sorted_by_values

Return an array of all keys sorted with their values using comparator.
private fun last_accessed_key: nullable Object

core :: HashCollection :: last_accessed_key

The last key accessed (used for cache)
private fun last_accessed_key=(last_accessed_key: nullable Object)

core :: HashCollection :: last_accessed_key=

The last key accessed (used for cache)
private fun last_accessed_node: nullable N

core :: HashCollection :: last_accessed_node

The last node accessed (used for cache)
private fun last_accessed_node=(last_accessed_node: nullable N)

core :: HashCollection :: last_accessed_node=

The last node accessed (used for cache)
private fun last_item: nullable N

core :: HashCollection :: last_item

private fun last_item=(last_item: nullable N)

core :: HashCollection :: last_item=

abstract fun length: Int

core :: MapRead :: length

Number of items in the collection.
fun lookup_all_values(pe: POSetElement[K]): Set[V]

core :: MapRead :: lookup_all_values

Search all the values in pe.greaters.
fun lookup_values(pe: POSetElement[K]): Set[V]

core :: MapRead :: lookup_values

Combine the values in pe.greaters from the most smaller elements that have a value.
protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array
private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.
init new: Map[K, V]

core :: Map :: new

Get a HashMap[K, V] as default implementation
private fun node_at(k: nullable Object): nullable N

core :: HashCollection :: node_at

Return the node associated with the key
private fun node_at_idx(i: Int, k: nullable Object): nullable N

core :: HashCollection :: node_at_idx

Return the node associated with the key (but with the index already known)
fun not_empty: Bool

core :: MapRead :: not_empty

Alias for not is_empty.
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun opt_bool(key: String): nullable Bool

nitc :: CmdOptions :: opt_bool

Get option value as bool
fun opt_int(key: String): nullable Int

nitc :: CmdOptions :: opt_int

Get option value for key as Int
private fun opt_mentity(model: Model, key: String): nullable MEntity

nitc :: CmdOptions :: opt_mentity

Get option as a MEntity
fun opt_string(key: String): nullable String

nitc :: CmdOptions :: opt_string

Get option value for key as String
fun opt_visibility(key: String): nullable MVisibility

nitc :: CmdOptions :: opt_visibility

Get option as a MVisibility
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).
protected fun provide_default_value(key: nullable Object): V

core :: MapRead :: provide_default_value

Called by the underling implementation of [] to provide a default value when a key has no value
private fun raz

core :: HashCollection :: raz

Clear the whole structure
fun recover_with(map: MapRead[K, V])

core :: Map :: recover_with

Alias for add_all
private fun remove_node(k: nullable Object)

core :: HashCollection :: remove_node

Remove the node assosiated with the key
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun serialize_msgpack(plain: nullable Bool): Bytes

serialization :: Serializable :: serialize_msgpack

Serialize self to MessagePack bytes
fun serialize_to(serializer: Serializer)

serialization :: Serializable :: serialize_to

Serialize self to serializer
fun serialize_to_json(plain: nullable Bool, pretty: nullable Bool): String

serialization :: Serializable :: serialize_to_json

Serialize self to JSON
private fun serialize_to_or_delay(v: Serializer)

serialization :: Serializable :: serialize_to_or_delay

Accept references or force direct serialization (using serialize_to)
private fun st_collide(i: Int, n: N)

core :: HashCollection :: st_collide

Count and update length of collisions for store
private fun store(index: Int, node: N)

core :: HashCollection :: store

Add a new node at a given index
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
private fun the_length=(the_length: Int)

core :: HashCollection :: the_length=

fun to_json: String

serialization :: Serializable :: to_json

Serialize self to plain JSON
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_map_comparator(comparator: Comparator): MapComparator[K, V]

core :: MapRead :: to_map_comparator

A comparator that compares things with their values in self.
fun to_pretty_json: String

serialization :: Serializable :: to_pretty_json

Serialize self to plain pretty JSON
fun to_s: String

core :: Object :: to_s

User readable representation of self.
abstract fun values: Collection[V]

core :: MapRead :: values

Return the point of view of self on the values only.
protected fun values=(values: RemovableCollection[V])

core :: HashMap :: values=

fun values_sorted_by_key(comparator: Comparator): Array[V]

core :: MapRead :: values_sorted_by_key

Return an array of all values sorted with their keys using comparator.
package_diagram nitc::CmdOptions CmdOptions core::HashMap HashMap nitc::CmdOptions->core::HashMap core::Map Map core::HashMap->core::Map core::hash_collection::HashCollection HashCollection core::HashMap->core::hash_collection::HashCollection ...core::Map ... ...core::Map->core::Map ...core::hash_collection::HashCollection ... ...core::hash_collection::HashCollection->core::hash_collection::HashCollection

Ancestors

private abstract class HashCollection[K: nullable Object]

core :: HashCollection

A HashCollection is an array of HashNode[K] indexed by the K hash value
interface Map[K: nullable Object, V: nullable Object]

core :: Map

Maps are associative collections: key -> item.
interface MapRead[K: nullable Object, V: nullable Object]

core :: MapRead

MapRead are abstract associative collections: key -> item.
interface Object

core :: Object

The root of the class hierarchy.
interface Serializable

serialization :: Serializable

Instances of this class can be passed to Serializer::serialize

Parents

class HashMap[K: nullable Object, V: nullable Object]

core :: HashMap

A Map implemented with a hash table.

Class definitions

nitc $ CmdOptions
# Commands options
class CmdOptions
	super HashMap[String,  String]

	# Map String visiblity name to MVisibility object
	var allowed_visibility: HashMap[String, MVisibility] is lazy do
		var res = new HashMap[String, MVisibility]
		res["public"] = public_visibility
		res["protected"] = protected_visibility
		res["private"] = private_visibility
		return res
	end

	# Get option value for `key` as String
	#
	# Return `null` if no option with that `key` or if value is empty.
	fun opt_string(key: String): nullable String do
		if not has_key(key) then return null
		var value = self[key]
		if value.is_empty then return null
		return value
	end

	# Get option value for `key` as Int
	#
	# Return `null` if no option with that `key` or if value is not an Int.
	fun opt_int(key: String): nullable Int do
		if not has_key(key) then return null
		var value = self[key]
		if not value.is_int then return null
		return value.to_i
	end

	# Get option value as bool
	#
	# Return `true` if the value with that `key` is empty or equals `"true"`.
	# Return `false` if the value with that `key` equals `"false"`.
	# Return `null` in any other case.
	fun opt_bool(key: String): nullable Bool do
		if not has_key(key) then return null
		var value = self[key]
		if value.is_empty or value == "true" then return true
		if value == "false" then return false
		return null
	end

	# Get option as a MVisibility
	#
	# Return `null` if no option with that `key` or if the value is not in
	# `allowed_visibility`.
	fun opt_visibility(key: String): nullable MVisibility do
		var value = opt_string(key)
		if value == null then return null
		if not allowed_visibility.keys.has(key) then return null
		return allowed_visibility[value]
	end

	# Get option as a MEntity
	#
	# Lookup first by `MEntity::full_name` then by `MEntity::name`.
	# Return `null` if the mentity name does not exist or return a conflict.
	private fun opt_mentity(model: Model, key: String): nullable MEntity do
		var value = opt_string(key)
		if value == null or value.is_empty then return null

		var mentity = model.mentity_by_full_name(value)
		if mentity != null then return mentity

		var mentities = model.mentities_by_name(value)
		if mentities.is_empty or mentities.length > 1 then return null
		return mentities.first
	end
end
src/doc/commands/commands_parser.nit:399,1--471,3