drv.AbstractSortedMap.drv Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/*
* 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 PACKAGE;
import VALUE_PACKAGE.VALUE_COLLECTION;
import VALUE_PACKAGE.VALUE_ABSTRACT_COLLECTION;
import VALUE_PACKAGE.VALUE_ABSTRACT_ITERATOR;
import VALUE_PACKAGE.VALUE_ITERATOR;
import it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator;
import it.unimi.dsi.fastutil.objects.ObjectSortedSet;
import java.util.Map;
#if KEYS_REFERENCE
import java.util.Comparator;
#endif
/** An abstract class providing basic methods for sorted maps implementing a type-specific interface. */
public abstract class ABSTRACT_SORTED_MAP KEY_VALUE_GENERIC extends ABSTRACT_MAP KEY_VALUE_GENERIC implements SORTED_MAP KEY_VALUE_GENERIC {
private static final long serialVersionUID = -1773560792952436569L;
protected ABSTRACT_SORTED_MAP() {}
#if KEYS_PRIMITIVE
/** Delegates to the corresponding type-specific method.
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
public SORTED_MAP KEY_VALUE_GENERIC headMap( final KEY_GENERIC_CLASS to ) {
return headMap( KEY_CLASS2TYPE( to ) );
}
/** Delegates to the corresponding type-specific method.
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
public SORTED_MAP KEY_VALUE_GENERIC tailMap( final KEY_GENERIC_CLASS from ) {
return tailMap( KEY_CLASS2TYPE( from ) );
}
/** Delegates to the corresponding type-specific method.
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
public SORTED_MAP KEY_VALUE_GENERIC subMap( final KEY_GENERIC_CLASS from, final KEY_GENERIC_CLASS to ) {
return subMap( KEY_CLASS2TYPE( from ), KEY_CLASS2TYPE( to ) );
}
/** Delegates to the corresponding type-specific method.
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
public KEY_GENERIC_CLASS firstKey() {
return KEY2OBJ( FIRST_KEY() );
}
/** Delegates to the corresponding type-specific method.
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
public KEY_GENERIC_CLASS lastKey() {
return KEY2OBJ( LAST_KEY() );
}
#endif
/** 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 SORTED_SET KEY_GENERIC keySet() {
return new KeySet();
}
/** A wrapper exhibiting the keys of a map. */
protected class KeySet extends ABSTRACT_SORTED_SET KEY_GENERIC {
public boolean contains( final KEY_TYPE k ) { return containsKey( k ); }
public int size() { return ABSTRACT_SORTED_MAP.this.size(); }
public void clear() { ABSTRACT_SORTED_MAP.this.clear(); }
public KEY_COMPARATOR KEY_SUPER_GENERIC comparator() { return ABSTRACT_SORTED_MAP.this.comparator(); }
public KEY_GENERIC_TYPE FIRST() { return FIRST_KEY(); }
public KEY_GENERIC_TYPE LAST() { return LAST_KEY(); }
public SORTED_SET KEY_GENERIC headSet( final KEY_GENERIC_TYPE to ) { return headMap( to ).keySet(); }
public SORTED_SET KEY_GENERIC tailSet( final KEY_GENERIC_TYPE from ) { return tailMap( from ).keySet(); }
public SORTED_SET KEY_GENERIC subSet( final KEY_GENERIC_TYPE from, final KEY_GENERIC_TYPE to ) { return subMap( from, to ).keySet(); }
public KEY_BIDI_ITERATOR KEY_GENERIC iterator( final KEY_GENERIC_TYPE from ) { return new KeySetIterator KEY_VALUE_GENERIC( entrySet().iterator( new BasicEntry KEY_VALUE_GENERIC( from, VALUE_NULL ) ) ); }
public KEY_BIDI_ITERATOR KEY_GENERIC iterator() { return new KeySetIterator KEY_VALUE_GENERIC( 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 KEY_VALUE_GENERIC extends KEY_ABSTRACT_BIDI_ITERATOR KEY_GENERIC {
protected final ObjectBidirectionalIterator> i;
public KeySetIterator( ObjectBidirectionalIterator> i ) {
this.i = i;
}
public KEY_GENERIC_TYPE NEXT_KEY() { return KEY_CLASS2TYPE( i.next().getKey() ); };
public KEY_GENERIC_TYPE PREV_KEY() { return KEY_CLASS2TYPE( i.previous().getKey() ); };
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 VALUE_COLLECTION VALUE_GENERIC values() {
return new ValuesCollection();
}
/** A wrapper exhibiting the values of a map. */
protected class ValuesCollection extends VALUE_ABSTRACT_COLLECTION VALUE_GENERIC {
public VALUE_ITERATOR VALUE_GENERIC iterator() { return new ValuesIterator KEY_VALUE_GENERIC( entrySet().iterator() ); }
public boolean contains( final VALUE_TYPE k ) { return containsValue( k ); }
public int size() { return ABSTRACT_SORTED_MAP.this.size(); }
public void clear() { ABSTRACT_SORTED_MAP.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 KEY_VALUE_GENERIC extends VALUE_ABSTRACT_ITERATOR VALUE_GENERIC {
protected final ObjectBidirectionalIterator> i;
public ValuesIterator( ObjectBidirectionalIterator> i ) {
this.i = i;
}
public VALUE_GENERIC_TYPE NEXT_VALUE() { return VALUE_CLASS2TYPE( i.next().getValue() ); };
public boolean hasNext() { return i.hasNext(); }
}
@SuppressWarnings({ "unchecked", "rawtypes" })
public ObjectSortedSet> entrySet() {
return (ObjectSortedSet)ENTRYSET();
}
}