A Github commit.

Should be accessed from GithubAPI::get_commit.

See https://developer.github.com/v3/repos/commits/.

Introduced properties

fun author: nullable GitUser

github :: Commit :: author

Author of the commit.
fun author=(author: nullable GitUser)

github :: Commit :: author=

Author of the commit.
fun author_date: nullable String

github :: Commit :: author_date

Authoring date as String.
fun author_date=(author_date: nullable String)

github :: Commit :: author_date=

Authoring date as String.
fun commit: nullable GitCommit

github :: Commit :: commit

Git commit representation linked to this commit.
protected fun commit=(commit: nullable GitCommit)

github :: Commit :: commit=

Git commit representation linked to this commit.
fun commit_date: nullable String

github :: Commit :: commit_date

Commit date as String.
fun commit_date=(commit_date: nullable String)

github :: Commit :: commit_date=

Commit date as String.
fun committer: nullable GitUser

github :: Commit :: committer

Committer of the commit.
fun committer=(committer: nullable GitUser)

github :: Commit :: committer=

Committer of the commit.
init defaultinit(sha: String, author: nullable GitUser, committer: nullable GitUser, author_date: nullable String, commit_date: nullable String, files: nullable Array[GithubFile], message: nullable String, commit: nullable GitCommit)

github :: Commit :: defaultinit

fun files: nullable Array[GithubFile]

github :: Commit :: files

List files staged in this commit.
fun files=(files: nullable Array[GithubFile])

github :: Commit :: files=

List files staged in this commit.
fun message: nullable String

github :: Commit :: message

Commit message.
fun message=(message: nullable String)

github :: Commit :: message=

Commit message.
protected fun mongo_id=(mongo_id: String)

github :: Commit :: mongo_id=

fun parents: nullable Array[Commit]

github :: Commit :: parents

Parent commits of self.
fun parents=(parents: nullable Array[Commit])

github :: Commit :: parents=

Parent commits of self.
fun sha: String

github :: Commit :: sha

Commit SHA.
fun sha=(sha: String)

github :: Commit :: sha=

Commit SHA.

Redefined properties

redef type SELF: Commit

github $ Commit :: SELF

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

github $ Commit :: core_serialize_to

Actual serialization of self to serializer
redef fun core_serialize_to(v: Serializer)

github :: loader $ Commit :: core_serialize_to

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

github $ Commit :: from_deserializer

Create an instance of this class from the deserializer
redef init from_deserializer(v: Deserializer)

github :: loader $ Commit :: 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
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
fun author: nullable GitUser

github :: Commit :: author

Author of the commit.
fun author=(author: nullable GitUser)

github :: Commit :: author=

Author of the commit.
fun author_date: nullable String

github :: Commit :: author_date

Authoring date as String.
fun author_date=(author_date: nullable String)

github :: Commit :: author_date=

Authoring date as String.
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 commit: nullable GitCommit

github :: Commit :: commit

Git commit representation linked to this commit.
protected fun commit=(commit: nullable GitCommit)

github :: Commit :: commit=

Git commit representation linked to this commit.
fun commit_date: nullable String

github :: Commit :: commit_date

Commit date as String.
fun commit_date=(commit_date: nullable String)

github :: Commit :: commit_date=

Commit date as String.
fun committer: nullable GitUser

github :: Commit :: committer

Committer of the commit.
fun committer=(committer: nullable GitUser)

github :: Commit :: committer=

Committer of the commit.
fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
init defaultinit(sha: String, author: nullable GitUser, committer: nullable GitUser, author_date: nullable String, commit_date: nullable String, files: nullable Array[GithubFile], message: nullable String, commit: nullable GitCommit)

github :: Commit :: defaultinit

fun files: nullable Array[GithubFile]

github :: Commit :: files

List files staged in this commit.
fun files=(files: nullable Array[GithubFile])

github :: Commit :: files=

List files staged in this commit.
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 message: nullable String

github :: Commit :: message

Commit message.
fun message=(message: nullable String)

github :: Commit :: message=

Commit message.
protected fun mongo_id=(mongo_id: String)

github :: Commit :: mongo_id=

protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array
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 parents: nullable Array[Commit]

github :: Commit :: parents

Parent commits of self.
fun parents=(parents: nullable Array[Commit])

github :: Commit :: parents=

Parent commits of self.
fun repo: nullable Repo

github :: RepoEntity :: repo

fun repo=(repo: nullable Repo)

github :: RepoEntity :: repo=

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
fun sha: String

github :: Commit :: sha

Commit SHA.
fun sha=(sha: String)

github :: Commit :: sha=

Commit SHA.
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.
package_diagram github::Commit Commit github::RepoEntity RepoEntity github::Commit->github::RepoEntity serialization::Serializable Serializable github::RepoEntity->serialization::Serializable ...serialization::Serializable ... ...serialization::Serializable->serialization::Serializable

Ancestors

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 definitions

github $ Commit
# A Github commit.
#
# Should be accessed from `GithubAPI::get_commit`.
#
# See <https://developer.github.com/v3/repos/commits/>.
class Commit
	serialize

	# Commit SHA.
	var sha: String is writable

	# Parent commits of `self`.
	var parents: nullable Array[Commit] = null is writable

	# Author of the commit.
	var author: nullable GitUser is writable

	# Committer of the commit.
	var committer: nullable GitUser is writable

	# Authoring date as String.
	var author_date: nullable String is writable

	# Commit date as String.
	var commit_date: nullable String is writable

	# List files staged in this commit.
	var files: nullable Array[GithubFile] = null is optional, writable

	# Commit message.
	var message: nullable String is writable

	# Git commit representation linked to this commit.
	var commit: nullable GitCommit
end
lib/github/api.nit:561,1--595,3

github :: loader $ Commit
redef class Commit
	super RepoEntity
	serialize

	var mongo_id: String is lazy, serialize_as("_id") do return sha
end
lib/github/loader.nit:481,1--486,3