it.unimi.dsi.fastutil.chars.AbstractChar2ObjectMap 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) */
/*
* 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;
import it.unimi.dsi.fastutil.objects.ObjectCollection;
import it.unimi.dsi.fastutil.objects.AbstractObjectCollection;
import it.unimi.dsi.fastutil.objects.ObjectIterator;
import it.unimi.dsi.fastutil.objects.AbstractObjectIterator;
import it.unimi.dsi.fastutil.objects.ObjectSet;
import java.util.Iterator;
import java.util.Map;
/**
* An abstract class providing basic methods for maps 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).
*
*
* As a further help, this class provides a {@link BasicEntry BasicEntry} inner
* class that implements a type-specific version of {@link java.util.Map.Entry};
* it is particularly useful for those classes that do not implement their own
* entries (e.g., most immutable maps).
*/
public abstract class AbstractChar2ObjectMap extends AbstractChar2ObjectFunction implements Char2ObjectMap, java.io.Serializable {
private static final long serialVersionUID = -4940583368468432370L;
protected AbstractChar2ObjectMap() {
}
/** Checks whether the given value is contained in {@link #values()}. */
public boolean containsValue(Object v) {
return values().contains(v);
}
/** Checks whether the given value is contained in {@link #keySet()}. */
public boolean containsKey(char k) {
return keySet().contains(k);
}
/**
* Puts all pairs in the given map. If the map implements the interface of
* this map, it uses the faster iterators.
*
* @param m
* a map.
*/
@SuppressWarnings({ "unchecked", "deprecation" })
public void putAll(Map m) {
int n = m.size();
final Iterator> i = m.entrySet().iterator();
if (m instanceof Char2ObjectMap) {
Char2ObjectMap.Entry e;
while (n-- != 0) {
e = (Char2ObjectMap.Entry) i.next();
put(e.getCharKey(), e.getValue());
}
} else {
Map.Entry e;
while (n-- != 0) {
e = i.next();
put(e.getKey(), e.getValue());
}
}
}
public boolean isEmpty() {
return size() == 0;
}
/**
* This class provides a basic but complete type-specific entry class for
* all those maps implementations that do not have entries on their own
* (e.g., most immutable maps).
*
*
* This class does not implement {@link java.util.Map.Entry#setValue(Object)
* setValue()}, as the modification would not be reflected in the base map.
*/
public static class BasicEntry implements Char2ObjectMap.Entry {
protected char key;
protected V value;
public BasicEntry(final Character key, final V value) {
this.key = ((key).charValue());
this.value = (value);
}
public BasicEntry(final char key, final V value) {
this.key = key;
this.value = value;
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method
* instead.
*/
@Deprecated
public Character getKey() {
return (Character.valueOf(key));
}
public char getCharKey() {
return key;
}
public V getValue() {
return (value);
}
public V setValue(final V value) {
throw new UnsupportedOperationException();
}
public boolean equals(final Object o) {
if (!(o instanceof Map.Entry)) return false;
final Map.Entry e = (Map.Entry) o;
if (e.getKey() == null || !(e.getKey() instanceof Character)) return false;
return ((key) == (((((Character) (e.getKey())).charValue())))) && ((value) == null ? ((e.getValue())) == null : (value).equals((e.getValue())));
}
public int hashCode() {
return (key) ^ ((value) == null ? 0 : (value).hashCode());
}
public String toString() {
return key + "->" + value;
}
}
/**
* Returns a type-specific-set view of the keys of this map.
*
*
* The view is backed by the set returned by {@link #entrySet()}. Note that
* no attempt is made at caching the result of this method, as this
* would require adding some attributes that lightweight implementations
* would not need. Subclasses may easily override this policy by calling
* this method and caching the result, but implementors are encouraged to
* write more efficient ad-hoc implementations.
*
* @return a set view of the keys of this map; it may be safely cast to a
* type-specific interface.
*/
public CharSet keySet() {
return new AbstractCharSet() {
public boolean contains(final char k) {
return containsKey(k);
}
public int size() {
return AbstractChar2ObjectMap.this.size();
}
public void clear() {
AbstractChar2ObjectMap.this.clear();
}
public CharIterator iterator() {
return new AbstractCharIterator() {
final ObjectIterator> i = entrySet().iterator();
@Override
public char nextChar() {
return ((Char2ObjectMap.Entry) i.next()).getCharKey();
};
@Override
public boolean hasNext() {
return i.hasNext();
}
@Override
public void remove() {
i.remove();
}
};
}
};
}
/**
* Returns a type-specific-set view of the values of this map.
*
*
* The view is backed by the set returned by {@link #entrySet()}. Note that
* no attempt is made at caching the result of this method, as this
* would require adding some attributes that lightweight implementations
* would not need. Subclasses may easily override this policy by calling
* this method and caching the result, but implementors are encouraged to
* write more efficient ad-hoc implementations.
*
* @return a set view of the values of this map; it may be safely cast to a
* type-specific interface.
*/
public ObjectCollection values() {
return new AbstractObjectCollection() {
public boolean contains(final Object k) {
return containsValue(k);
}
public int size() {
return AbstractChar2ObjectMap.this.size();
}
public void clear() {
AbstractChar2ObjectMap.this.clear();
}
public ObjectIterator iterator() {
return new AbstractObjectIterator() {
final ObjectIterator> i = entrySet().iterator();
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific
* method instead.
*/
@Deprecated
public V next() {
return ((Char2ObjectMap.Entry) i.next()).getValue();
};
public boolean hasNext() {
return i.hasNext();
}
};
}
};
}
@SuppressWarnings({ "unchecked", "rawtypes" })
public ObjectSet> entrySet() {
return (ObjectSet) char2ObjectEntrySet();
}
/**
* Returns a hash code for this map.
*
* The hash code of a map is computed by summing the hash codes of its
* entries.
*
* @return a hash code for this map.
*/
public int hashCode() {
int h = 0, n = size();
final ObjectIterator> i = entrySet().iterator();
while (n-- != 0)
h += i.next().hashCode();
return h;
}
public boolean equals(Object o) {
if (o == this) return true;
if (!(o instanceof Map)) return false;
Map m = (Map) o;
if (m.size() != size()) return false;
return entrySet().containsAll(m.entrySet());
}
public String toString() {
final StringBuilder s = new StringBuilder();
final ObjectIterator> i = entrySet().iterator();
int n = size();
Char2ObjectMap.Entry e;
boolean first = true;
s.append("{");
while (n-- != 0) {
if (first) first = false;
else s.append(", ");
e = (Char2ObjectMap.Entry) i.next();
s.append(String.valueOf(e.getCharKey()));
s.append("=>");
if (this == e.getValue()) s.append("(this map)");
else s.append(String.valueOf(e.getValue()));
}
s.append("}");
return s.toString();
}
}