it.unimi.dsi.fastutil.objects.ObjectCollection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-concurrent Show documentation
The concurrency library which includes the coroutines functionality
There is a newer version: 2.0.5
/* Generic definitions */

/* Assertions (useful to generate conditional code) */

/* Current type and class (and size, if applicable) */
/* Value methods */

/* Interfaces (keys) */
/* Interfaces (values) */
/* Abstract implementations (keys) */
/* Abstract implementations (values) */

/* Static containers (keys) */
/* Static containers (values) */

/* Implementations */
/* Synchronized wrappers */
/* Unmodifiable wrappers */
/* Other wrappers */

/* Methods (keys) */
/* Methods (values) */
/* Methods (keys/values) */

/* Methods that have special names depending on keys (but the special names depend on values) */

/* Equality */
/* Object/Reference-only definitions (keys) */
/* Object/Reference-only definitions (values) */
/*
 * Copyright (C) 2002-2016 Sebastiano Vigna
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package it.unimi.dsi.fastutil.objects;

import it.unimi.dsi.fastutil.objects.ObjectIterable;
import it.unimi.dsi.fastutil.objects.ObjectIterator;

import java.util.Collection;

/**
 * A type-specific {@link Collection}; provides some additional methods that use
 * polymorphism to avoid (un)boxing.
 *
 * 
 * Additionally, this class defines strengthens (again) {@link #iterator()} and
 * defines a slightly different semantics for {@link #toArray(Object[])}.
 *
 * @see Collection
 */

public interface ObjectCollection extends Collection, ObjectIterable {
	
	/**
	 * Returns a type-specific iterator on the elements of this collection.
	 *
	 * 

	 * Note that this specification strengthens the one given in
	 * {@link Iterable#iterator()}, which was already strengthened in
	 * the corresponding type-specific class, but was weakened by the fact that
	 * this interface extends {@link Collection}.
	 *
	 * @return a type-specific iterator on the elements of this collection.
	 */
	ObjectIterator iterator();
	
	/**
	 * Returns a type-specific iterator on this elements of this collection.
	 *
	 * @see #iterator()
	 * @deprecated As of fastutil 5, replaced by
	 *             {@link #iterator()}.
	 */
	@Deprecated
	ObjectIterator objectIterator();
	
	/**
	 * Returns an containing the items of this collection; the runtime type of
	 * the returned array is that of the specified array.
	 *
	 * 
	 * Warning: Note that, contrarily to
	 * {@link Collection#toArray(Object[])}, this methods just writes all
	 * elements of this collection: no special value will be added after the
	 * last one.
	 *
	 * @param a
	 *            if this array is big enough, it will be used to store this
	 *            collection.
	 * @return a primitive type array containing the items of this collection.
	 * @see Collection#toArray(Object[])
	 */
	 T[] toArray(T[] a);
}