class MPackageStats

nitc :: MPackageStats

MPackage statistics for the catalog

Introduced properties

private var _commits: Int

nitc :: MPackageStats :: _commits

Number of commits by package
private var _documentation_score: Int

nitc :: MPackageStats :: _documentation_score

Documentation score (between 0 and 100)
private var _errors: Int

nitc :: MPackageStats :: _errors

Number of errors
private var _loc: Int

nitc :: MPackageStats :: _loc

Number of lines of code
private var _mclasses: Int

nitc :: MPackageStats :: _mclasses

Number of classes
private var _mmethods: Int

nitc :: MPackageStats :: _mmethods

Number of methods
private var _mmodules: Int

nitc :: MPackageStats :: _mmodules

Number of modules
private var _score: Int

nitc :: MPackageStats :: _score

Score by package
private var _warnings: Int

nitc :: MPackageStats :: _warnings

Number of warnings and advices
private var _warnings_per_kloc: Int

nitc :: MPackageStats :: _warnings_per_kloc

Number of warnings per 1000 lines of code (w/kloc)
fun commits: Int

nitc :: MPackageStats :: commits

Number of commits by package
protected fun commits=(commits: Int)

nitc :: MPackageStats :: commits=

Number of commits by package
fun documentation_score: Int

nitc :: MPackageStats :: documentation_score

Documentation score (between 0 and 100)
protected fun documentation_score=(documentation_score: Int)

nitc :: MPackageStats :: documentation_score=

Documentation score (between 0 and 100)
fun errors: Int

nitc :: MPackageStats :: errors

Number of errors
protected fun errors=(errors: Int)

nitc :: MPackageStats :: errors=

Number of errors
fun loc: Int

nitc :: MPackageStats :: loc

Number of lines of code
protected fun loc=(loc: Int)

nitc :: MPackageStats :: loc=

Number of lines of code
fun mclasses: Int

nitc :: MPackageStats :: mclasses

Number of classes
protected fun mclasses=(mclasses: Int)

nitc :: MPackageStats :: mclasses=

Number of classes
fun mmethods: Int

nitc :: MPackageStats :: mmethods

Number of methods
protected fun mmethods=(mmethods: Int)

nitc :: MPackageStats :: mmethods=

Number of methods
fun mmodules: Int

nitc :: MPackageStats :: mmodules

Number of modules
protected fun mmodules=(mmodules: Int)

nitc :: MPackageStats :: mmodules=

Number of modules
fun score: Int

nitc :: MPackageStats :: score

Score by package
protected fun score=(score: Int)

nitc :: MPackageStats :: score=

Score by package
fun warnings: Int

nitc :: MPackageStats :: warnings

Number of warnings and advices
protected fun warnings=(warnings: Int)

nitc :: MPackageStats :: warnings=

Number of warnings and advices
fun warnings_per_kloc: Int

nitc :: MPackageStats :: warnings_per_kloc

Number of warnings per 1000 lines of code (w/kloc)
protected fun warnings_per_kloc=(warnings_per_kloc: Int)

nitc :: MPackageStats :: warnings_per_kloc=

Number of warnings per 1000 lines of code (w/kloc)

Redefined properties

redef type SELF: MPackageStats

nitc $ MPackageStats :: SELF

Type of this instance, automatically specialized in every class
redef fun core_serialize_to(v: Serializer)

nitc :: json_model $ MPackageStats :: core_serialize_to

Actual serialization of self to serializer
redef init from_deserializer(v: Deserializer)

nitc :: json_model $ MPackageStats :: from_deserializer

Create an instance of this class from the deserializer

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 _commits: Int

nitc :: MPackageStats :: _commits

Number of commits by package
private var _documentation_score: Int

nitc :: MPackageStats :: _documentation_score

Documentation score (between 0 and 100)
private var _errors: Int

nitc :: MPackageStats :: _errors

Number of errors
private var _loc: Int

nitc :: MPackageStats :: _loc

Number of lines of code
private var _mclasses: Int

nitc :: MPackageStats :: _mclasses

Number of classes
private var _mmethods: Int

nitc :: MPackageStats :: _mmethods

Number of methods
private var _mmodules: Int

nitc :: MPackageStats :: _mmodules

Number of modules
private var _score: Int

nitc :: MPackageStats :: _score

Score by package
private var _warnings: Int

nitc :: MPackageStats :: _warnings

Number of warnings and advices
private var _warnings_per_kloc: Int

nitc :: MPackageStats :: _warnings_per_kloc

Number of warnings per 1000 lines of code (w/kloc)
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
protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according
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 commits: Int

nitc :: MPackageStats :: commits

Number of commits by package
protected fun commits=(commits: Int)

nitc :: MPackageStats :: commits=

Number of commits by package
fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
fun documentation_score: Int

nitc :: MPackageStats :: documentation_score

Documentation score (between 0 and 100)
protected fun documentation_score=(documentation_score: Int)

nitc :: MPackageStats :: documentation_score=

Documentation score (between 0 and 100)
fun errors: Int

nitc :: MPackageStats :: errors

Number of errors
protected fun errors=(errors: Int)

nitc :: MPackageStats :: errors=

Number of errors
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 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.
fun loc: Int

nitc :: MPackageStats :: loc

Number of lines of code
protected fun loc=(loc: Int)

nitc :: MPackageStats :: loc=

Number of lines of code
fun mclasses: Int

nitc :: MPackageStats :: mclasses

Number of classes
protected fun mclasses=(mclasses: Int)

nitc :: MPackageStats :: mclasses=

Number of classes
fun mmethods: Int

nitc :: MPackageStats :: mmethods

Number of methods
protected fun mmethods=(mmethods: Int)

nitc :: MPackageStats :: mmethods=

Number of methods
fun mmodules: Int

nitc :: MPackageStats :: mmodules

Number of modules
protected fun mmodules=(mmodules: Int)

nitc :: MPackageStats :: mmodules=

Number of modules
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.
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 score: Int

nitc :: MPackageStats :: score

Score by package
protected fun score=(score: Int)

nitc :: MPackageStats :: score=

Score by package
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)
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
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_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.
fun warnings: Int

nitc :: MPackageStats :: warnings

Number of warnings and advices
protected fun warnings=(warnings: Int)

nitc :: MPackageStats :: warnings=

Number of warnings and advices
fun warnings_per_kloc: Int

nitc :: MPackageStats :: warnings_per_kloc

Number of warnings per 1000 lines of code (w/kloc)
protected fun warnings_per_kloc=(warnings_per_kloc: Int)

nitc :: MPackageStats :: warnings_per_kloc=

Number of warnings per 1000 lines of code (w/kloc)
package_diagram nitc::MPackageStats MPackageStats serialization::Serializable Serializable nitc::MPackageStats->serialization::Serializable core::Object Object serialization::Serializable->core::Object ...core::Object ... ...core::Object->core::Object

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

interface Serializable

serialization :: Serializable

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

Class definitions

nitc $ MPackageStats 
# MPackage statistics for the catalog
class MPackageStats

	# Number of modules
	var mmodules = 0

	# Number of classes
	var mclasses = 0

	# Number of methods
	var mmethods = 0

	# Number of lines of code
	var loc = 0

	# Number of errors
	var errors = 0

	# Number of warnings and advices
	var warnings = 0

	# Number of warnings per 1000 lines of code (w/kloc)
	var warnings_per_kloc = 0

	# Documentation score (between 0 and 100)
	var documentation_score = 0

	# Number of commits by package
	var commits = 0

	# Score by package
	#
	# The score is loosely computed using other metrics
	var score = 0
end
src/catalog/catalog.nit:587,1--621,3

nitc :: json_model $ MPackageStats 
# MPackage statistics for the catalog
redef class MPackageStats
	serialize

	redef fun core_serialize_to(v) do
		super
		v.serialize_attribute("mmodules", mmodules)
		v.serialize_attribute("mclasses", mclasses)
		v.serialize_attribute("mmethods", mmethods)
		v.serialize_attribute("loc", loc)
		v.serialize_attribute("errors", errors)
		v.serialize_attribute("warnings", warnings)
		v.serialize_attribute("warnings_per_kloc", warnings_per_kloc)
		v.serialize_attribute("documentation_score", documentation_score)
		v.serialize_attribute("commits", commits)
		v.serialize_attribute("score", score)
	end
end
src/doc/templates/json_model.nit:419,1--436,3
Nit tools. Version .