it.unimi.dsi.fastutil.chars.AbstractChar2ReferenceSortedMap Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/* 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.ReferenceCollection;
import it.unimi.dsi.fastutil.objects.AbstractReferenceCollection;
import it.unimi.dsi.fastutil.objects.AbstractObjectIterator;
import it.unimi.dsi.fastutil.objects.ObjectIterator;
import it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator;
import it.unimi.dsi.fastutil.objects.ObjectSortedSet;
import java.util.Map;
/**
* An abstract class providing basic methods for sorted maps implementing a
* type-specific interface.
*/
public abstract class AbstractChar2ReferenceSortedMap
extends
AbstractChar2ReferenceMap implements Char2ReferenceSortedMap {
private static final long serialVersionUID = -1773560792952436569L;
protected AbstractChar2ReferenceSortedMap() {
}
/**
* Delegates to the corresponding type-specific method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
public Char2ReferenceSortedMap headMap(final Character to) {
return headMap(((to).charValue()));
}
/**
* Delegates to the corresponding type-specific method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
public Char2ReferenceSortedMap tailMap(final Character from) {
return tailMap(((from).charValue()));
}
/**
* Delegates to the corresponding type-specific method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
public Char2ReferenceSortedMap subMap(final Character from,
final Character to) {
return subMap(((from).charValue()), ((to).charValue()));
}
/**
* Delegates to the corresponding type-specific method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
public Character firstKey() {
return (Character.valueOf(firstCharKey()));
}
/**
* Delegates to the corresponding type-specific method.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
public Character lastKey() {
return (Character.valueOf(lastCharKey()));
}
/**
* Returns a type-specific-sorted-set view of the keys of this map.
*
*
* The view is backed by the sorted 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 sorted set view of the keys of this map; it may be safely cast
* to a type-specific interface.
*/
public CharSortedSet keySet() {
return new KeySet();
}
/** A wrapper exhibiting the keys of a map. */
protected class KeySet extends AbstractCharSortedSet {
public boolean contains(final char k) {
return containsKey(k);
}
public int size() {
return AbstractChar2ReferenceSortedMap.this.size();
}
public void clear() {
AbstractChar2ReferenceSortedMap.this.clear();
}
public CharComparator comparator() {
return AbstractChar2ReferenceSortedMap.this.comparator();
}
public char firstChar() {
return firstCharKey();
}
public char lastChar() {
return lastCharKey();
}
public CharSortedSet headSet(final char to) {
return headMap(to).keySet();
}
public CharSortedSet tailSet(final char from) {
return tailMap(from).keySet();
}
public CharSortedSet subSet(final char from, final char to) {
return subMap(from, to).keySet();
}
public CharBidirectionalIterator iterator(final char from) {
return new KeySetIterator(entrySet().iterator(
new BasicEntry(from, (null))));
}
public CharBidirectionalIterator iterator() {
return new KeySetIterator(entrySet().iterator());
}
}
/**
* A wrapper exhibiting a map iterator as an iterator on keys.
*
*
* To provide an iterator on keys, just create an instance of this class
* using the corresponding iterator on entries.
*/
protected static class KeySetIterator
extends
AbstractCharBidirectionalIterator {
protected final ObjectBidirectionalIterator> i;
public KeySetIterator(
ObjectBidirectionalIterator> i) {
this.i = i;
}
public char nextChar() {
return ((i.next().getKey()).charValue());
};
public char previousChar() {
return ((i.previous().getKey()).charValue());
};
public boolean hasNext() {
return i.hasNext();
}
public boolean hasPrevious() {
return i.hasPrevious();
}
}
/**
* Returns a type-specific collection view of the values contained in this
* map.
*
*
* The view is backed by the sorted 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 type-specific collection view of the values contained in this
* map.
*/
public ReferenceCollection values() {
return new ValuesCollection();
}
/** A wrapper exhibiting the values of a map. */
protected class ValuesCollection extends AbstractReferenceCollection {
public ObjectIterator iterator() {
return new ValuesIterator(entrySet().iterator());
}
public boolean contains(final Object k) {
return containsValue(k);
}
public int size() {
return AbstractChar2ReferenceSortedMap.this.size();
}
public void clear() {
AbstractChar2ReferenceSortedMap.this.clear();
}
}
/**
* A wrapper exhibiting a map iterator as an iterator on values.
*
*
* To provide an iterator on values, just create an instance of this class
* using the corresponding iterator on entries.
*/
protected static class ValuesIterator extends AbstractObjectIterator {
protected final ObjectBidirectionalIterator> i;
public ValuesIterator(
ObjectBidirectionalIterator> i) {
this.i = i;
}
public V next() {
return (i.next().getValue());
};
public boolean hasNext() {
return i.hasNext();
}
}
@SuppressWarnings({"unchecked", "rawtypes"})
public ObjectSortedSet> entrySet() {
return (ObjectSortedSet) char2ReferenceEntrySet();
}
}