A collection that contains only one item.

Used to pass arguments by reference.

Also used when one want to give a single element when a full collection is expected

Introduced properties

init defaultinit(item: E)

core :: Ref :: defaultinit

fun item: E

core :: Ref :: item

The stored item

fun item=(item: E)

core :: Ref :: item=

The stored item

Redefined properties

redef fun ==(other: nullable Object): Bool

functional :: test_iter_extras $ Ref :: ==

Have self and other the same value?

redef type SELF: Ref[E]

core $ Ref :: SELF

Type of this instance, automatically specialized in every class

redef fun core_serialize_to(v: Serializer)

serialization :: serialization_core $ Ref :: core_serialize_to

Actual serialization of self to serializer

redef fun count(an_item: nullable Object): Int

core $ Ref :: count

How many occurrences of item are in the collection?

redef fun first: E

core $ Ref :: first

Return the first item of the collection

redef init from_deserializer(v: Deserializer)

serialization :: serialization_core $ Ref :: from_deserializer

Create an instance of this class from the deserializer

redef fun has(an_item: nullable Object): Bool

core $ Ref :: has

Is item in the collection ?

redef fun has_only(an_item: nullable Object): Bool

core $ Ref :: has_only

Is the collection contain only item?

redef fun is_empty: Bool

core $ Ref :: is_empty

Is there no item in the collection?

redef fun iterator: Iterator[E]

core $ Ref :: iterator

Get a new iterator on the collection.

redef fun length: Int

core $ Ref :: length

Number of items in the collection.

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 CONCURRENT: ConcurrentCollection[E]

core :: Collection :: CONCURRENT

Type of the concurrent variant of this collection

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

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 combinations(r: Int): Collection[SequenceRead[E]]

core :: Collection :: combinations

All r-length combinations on self (in same order) without repeated elements.

fun combinations_with_replacement(r: Int): Collection[SequenceRead[E]]

core :: Collection :: combinations_with_replacement

All r-length combination on self (in same order) with repeated elements.

fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer

fun count(item: nullable Object): Int

core :: Collection :: count

How many occurrences of item are in the collection?

init defaultinit

serialization :: Serializable :: defaultinit

init defaultinit

core :: Object :: defaultinit

init defaultinit(item: E)

core :: Ref :: defaultinit

init defaultinit

core :: Collection :: defaultinit

fun first: E

core :: Collection :: first

Return the first item of the collection

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 has(item: nullable Object): Bool

core :: Collection :: has

Is item in the collection ?

fun has_all(other: Collection[nullable Object]): Bool

core :: Collection :: has_all

Does the collection contain at least each element of other?

fun has_any(other: Collection[nullable Object]): Bool

core :: Collection :: has_any

Does the collection contain at least one element of other?

fun has_exactly(other: Collection[nullable Object]): Bool

core :: Collection :: has_exactly

Does the collection contain exactly all the elements of other?

fun has_only(item: nullable Object): Bool

core :: Collection :: has_only

Is the collection contain only item?

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".

fun is_empty: Bool

core :: Collection :: 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.

fun item: E

core :: Ref :: item

The stored item

fun item=(item: E)

core :: Ref :: item=

The stored item

abstract fun iterator: Iterator[E]

core :: Collection :: iterator

Get a new iterator on the collection.

fun join(separator: nullable Text, last_separator: nullable Text): String

core :: Collection :: join

Concatenate and separate each elements with separator.

fun length: Int

core :: Collection :: length

Number of items in the collection.

protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array

fun not_empty: Bool

core :: Collection :: 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 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 permutations(r: Int): Collection[SequenceRead[E]]

core :: Collection :: permutations

All r-length permutations on self (all possible ordering) without repeated elements.

fun plain_to_s: String

core :: Collection :: plain_to_s

Concatenate elements without separators

fun product(r: Int): Collection[SequenceRead[E]]

core :: Collection :: product

Cartesian product, over r times self.

fun rand: E

core :: Collection :: rand

Return a random element form the collection

fun sample(length: Int): Array[E]

core :: Collection :: sample

Return a new array made of (at most) length elements randomly chosen.

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

intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.

fun to_a: Array[E]

core :: Collection :: to_a

Build a new array from a collection

abstract fun to_concurrent: CONCURRENT

core :: Collection :: to_concurrent

Wraps self in a thread-safe collection

fun to_counter: Counter[E]

core :: Collection :: to_counter

Create and fill up a counter with the elements of `self.

fun to_curlslist: CURLSList

core :: Collection :: to_curlslist

Convert Collection[String] to CURLSList

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 to_shuffle: Array[E]

core :: Collection :: to_shuffle

Return a new array made of elements in a random order.

Ancestors

interface Object

The root of the class hierarchy.

Parents

interface Collection[E: nullable Object]

core :: Collection

The root of the collection hierarchy.

interface Serializable

serialization :: Serializable

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

Class definitions

core $ Ref

# A collection that contains only one item.
#
# Used to pass arguments by reference.
#
# Also used when one want to give a single element when a full
# collection is expected
class Ref[E]
	super Collection[E]

	redef fun first do return item

	redef fun is_empty do return false

	redef fun length do return 1

	redef fun has(an_item) do return item == an_item

	redef fun has_only(an_item) do return item == an_item

	redef fun count(an_item)
	do
		if item == an_item then
			return 1
		else
			return 0
		end
	end

	redef fun iterator do return new RefIterator[E](self)

	# The stored item
	var item: E is writable
end

lib/core/collection/abstract_collection.nit:349,1--381,3

functional :: test_iter_extras $ Ref

redef class Ref[E]
        redef fun ==(other) do
                if other isa Ref[E] then
                        return self.item == other.item
                end
                return false
        end
end

lib/functional/test_iter_extras.nit:22,1--29,3

serialization :: serialization_core $ Ref

redef class Ref[E]
	super Serializable

	redef init from_deserializer(v)
	do
		v.notify_of_creation self
		var item = v.deserialize_attribute("item")
		init item
	end

	redef fun core_serialize_to(v)
	do
		v.serialize_attribute("item", first)
	end
end

lib/serialization/serialization_core.nit:286,1--300,3