it.unimi.dsi.fastutil.longs.AbstractLong2LongFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fastutil Show documentation

fastutil extends the Java Collections Framework by providing type-specific maps, sets, lists, and queues with a small memory footprint and fast access and insertion; it provides also big (64-bit) arrays, sets and lists, sorting algorithms, fast, practical I/O classes for binary and text files, and facilities for memory mapping large files. Note that if you have both this jar and fastutil-core.jar in your dependencies, fastutil-core.jar should be excluded.

There is a newer version: 8.5.15

Show newest version

/* 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) */
/* Primitive-type-only definitions (keys) */
/* Object/Reference-only definitions (values) */
/* Primitive-type-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.longs;
/**
 * An abstract class providing basic methods for functions implementing a
 * type-specific interface.
 *
 * 
 * Optional operations just throw an {@link UnsupportedOperationException}.
 * Generic versions of accessors delegate to the corresponding type-specific
 * counterparts following the interface rules (they take care of returning
 * null on a missing key).
 *
 * 

 * This class handles directly a default return value (including
 * {@linkplain #defaultReturnValue() methods to access it}). Instances of classes
 * inheriting from this class have just to return defRetValue to
 * denote lack of a key in type-specific methods. The value is serialized.
 *
 * 

 * Implementing subclasses have just to provide type-specific get()
 * , type-specific containsKey(), and size() methods.
 *
 */
public abstract class AbstractLong2LongFunction
		implements
			Long2LongFunction,
			java.io.Serializable {
	private static final long serialVersionUID = -4940583368468432370L;
	protected AbstractLong2LongFunction() {
	}
	/**
	 * The default return value for get(), put() and
	 * remove().
	 */
	protected long defRetValue;
	public void defaultReturnValue(final long rv) {
		defRetValue = rv;
	}
	public long defaultReturnValue() {
		return defRetValue;
	}
	public long put(long key, long value) {
		throw new UnsupportedOperationException();
	}
	public long remove(long key) {
		throw new UnsupportedOperationException();
	}
	public void clear() {
		throw new UnsupportedOperationException();
	}
	public boolean containsKey(final Object ok) {
		if (ok == null)
			return false;
		return containsKey(((((Long) (ok)).longValue())));
	}
	/**
	 * Delegates to the corresponding type-specific method, taking care of
	 * returning null on a missing key.
	 *
	 * 

	 * This method must check whether the provided key is in the map using
	 * containsKey(). Thus, it probes the map twice.
	 * Implementors of subclasses should override it with a more efficient
	 * method.
	 *
	 * @deprecated Please use the corresponding type-specific method instead.
	 */
	@Deprecated
	public Long get(final Object ok) {
		if (ok == null)
			return null;
		final long k = ((((Long) (ok)).longValue()));
		return containsKey(k) ? (Long.valueOf(get(k))) : null;
	}
	/**
	 * Delegates to the corresponding type-specific method, taking care of
	 * returning null on a missing key.
	 *
	 * 

	 * This method must check whether the provided key is in the map using
	 * containsKey(). Thus, it probes the map twice.
	 * Implementors of subclasses should override it with a more efficient
	 * method.
	 *
	 * @deprecated Please use the corresponding type-specific method instead.
	 */
	@Deprecated
	public Long put(final Long ok, final Long ov) {
		final long k = ((ok).longValue());
		final boolean containsKey = containsKey(k);
		final long v = put(k, ((ov).longValue()));
		return containsKey ? (Long.valueOf(v)) : null;
	}
	/**
	 * Delegates to the corresponding type-specific method, taking care of
	 * returning null on a missing key.
	 *
	 * 
	 * This method must check whether the provided key is in the map using
	 * containsKey(). Thus, it probes the map twice.
	 * Implementors of subclasses should override it with a more efficient
	 * method.
	 *
	 * @deprecated Please use the corresponding type-specific method instead.
	 */
	@Deprecated
	public Long remove(final Object ok) {
		if (ok == null)
			return null;
		final long k = ((((Long) (ok)).longValue()));
		final boolean containsKey = containsKey(k);
		final long v = remove(k);
		return containsKey ? (Long.valueOf(v)) : null;
	}
}