it.unimi.dsi.fastutil.chars.AbstractChar2IntFunction Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/* Copyright (C) 1991-2016 Free Software Foundation, Inc.
This file is part of the GNU C Library.
The GNU C Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
The GNU C Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with the GNU C Library; if not, see
or any other header that includes
because the implicit include comes before any feature
test macros that may be defined in a source file before it first
explicitly includes a system header. GCC knows the name of this
header in order to preinclude it. */
/* glibc's intent is to support the IEC 559 math functionality, real
and complex. If the GCC (4.9 and later) predefined macros
specifying compiler intent are available, use them to determine
whether the overall intent is to support these features; otherwise,
presume an older compiler has intent to support these features and
define these macros by default. */
/* wchar_t uses Unicode 9.0.0. Version 9.0 of the Unicode Standard is
synchronized with ISO/IEC 10646:2014, fourth edition, plus
Amd. 1 and Amd. 2 and 273 characters from forthcoming 10646, fifth edition.
(Amd. 2 was published 2016-05-01,
see https://www.iso.org/obp/ui/#iso:std:iso-iec:10646:ed-4:v1:amd:2:v1:en) */
/* We do not support C11 . */
/* 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.chars;
/**
* 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 AbstractChar2IntFunction implements Char2IntFunction, java.io.Serializable {
private static final long serialVersionUID = -4940583368468432370L;
protected AbstractChar2IntFunction() {
}
/**
* 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(char key, int value) {
throw new UnsupportedOperationException();
}
public int remove(char key) {
throw new UnsupportedOperationException();
}
public void clear() {
throw new UnsupportedOperationException();
}
public boolean containsKey(final Object ok) {
if (ok == null) return false;
return containsKey(((((Character) (ok)).charValue())));
}
/**
* 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) {
if (ok == null) return null;
final char k = ((((Character) (ok)).charValue()));
return containsKey(k) ? (Integer.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 Integer put(final Character ok, final Integer ov) {
final char k = ((ok).charValue());
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) {
if (ok == null) return null;
final char k = ((((Character) (ok)).charValue()));
final boolean containsKey = containsKey(k);
final int v = remove(k);
return containsKey ? (Integer.valueOf(v)) : null;
}
}