it.unimi.dsi.fastutil.objects.AbstractObject2IntFunction Maven / Gradle / Ivy
/* 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) */
/* 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.objects;
/**
* 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 AbstractObject2IntFunction
implements
Object2IntFunction,
java.io.Serializable {
private static final long serialVersionUID = -4940583368468432370L;
protected AbstractObject2IntFunction() {
}
/**
* The default return value for get(), put() and
* remove().
*/
protected int defRetValue;
public void defaultReturnValue(final int rv) {
defRetValue = rv;
}
public int defaultReturnValue() {
return defRetValue;
}
public int put(K key, int value) {
throw new UnsupportedOperationException();
}
public int removeInt(Object key) {
throw new UnsupportedOperationException();
}
public void clear() {
throw new UnsupportedOperationException();
}
/**
* 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 Integer get(final Object ok) {
final Object k = (ok);
return containsKey(k) ? (Integer.valueOf(getInt(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 Integer put(final K ok, final Integer ov) {
final K k = (ok);
final boolean containsKey = containsKey(k);
final int v = put(k, ((ov).intValue()));
return containsKey ? (Integer.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 Integer remove(final Object ok) {
final Object k = (ok);
final boolean containsKey = containsKey(k);
final int v = removeInt(k);
return containsKey ? (Integer.valueOf(v)) : null;
}
}