/* 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) */
/*
* fastutil: Fast & compact type-specific collections for Java
*
* Copyright (C) 2002-2008 Sebastiano Vigna
*
* This 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.
*
* This 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 this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
package it.unimi.dsi.fastutil.objects;
/** A class providing static methods and objects that do useful things with type-specific functions.
*
* @see it.unimi.dsi.fastutil.Function
* @see java.util.Collections
*/
public class Reference2FloatFunctions {
private Reference2FloatFunctions() {}
/** An immutable class representing an empty type-specific function.
*
* <P>This class may be useful to implement your own in case you subclass
* a type-specific function.
*/
public static class EmptyFunction <K> extends AbstractReference2FloatFunction <K> implements java.io.Serializable, Cloneable {
public static final long serialVersionUID = -7046029254386353129L;
protected EmptyFunction() {}
public float getFloat( final Object k ) { return (0); }
public boolean containsKey( final Object k ) { return false; }
public float defaultReturnValue() { return (0); }
public void defaultReturnValue( final float defRetValue ) { throw new UnsupportedOperationException(); }
public int size() { return 0; }
public void clear() {}
private Object readResolve() { return EMPTY_FUNCTION; }
public Object clone() { return EMPTY_FUNCTION; }
}
/** An empty type-specific function (immutable). It is serializable and cloneable. */
@SuppressWarnings("unchecked")
public static final EmptyFunction EMPTY_FUNCTION = new EmptyFunction();
/** An immutable class representing a type-specific singleton function.
*
* <P>This class may be useful to implement your own in case you subclass
* a type-specific function.
*/
public static class Singleton <K> extends AbstractReference2FloatFunction <K> implements java.io.Serializable, Cloneable {
public static final long serialVersionUID = -7046029254386353129L;
protected final K key;
protected final float value;
protected Singleton( final K key, final float value ) {
this.key = key;
this.value = value;
}
public boolean containsKey( final Object k ) { return ( (key) == (k) ); }
public float getFloat( final Object k ) { if ( ( (key) == (k) ) ) return value; return defRetValue; }
public int size() { return 1; }
public Object clone() { return this; }
}
/** Returns a type-specific immutable function containing only the specified pair. The returned function is serializable and cloneable.
*
* <P>Note that albeit the returned function is immutable, its default return value may be changed.
*
* @param key the only key of the returned function.
* @param value the only value of the returned function.
* @return a type-specific immutable function containing just the pair <code><key,value></code>.
*/
public static <K> Reference2FloatFunction <K> singleton( final K key, float value ) {
return new Singleton <K>( key, value );
}
/** Returns a type-specific immutable function containing only the specified pair. The returned function is serializable and cloneable.
*
* <P>Note that albeit the returned function is immutable, its default return value may be changed.
*
* @param key the only key of the returned function.
* @param value the only value of the returned function.
* @return a type-specific immutable function containing just the pair <code><key,value></code>.
*/
public static <K> Reference2FloatFunction <K> singleton( final K key, final Float value ) {
return new Singleton <K>( (key), ((value).floatValue()) );
}
/** A synchronized wrapper class for functions. */
public static class SynchronizedFunction <K> extends AbstractReference2FloatFunction <K> implements java.io.Serializable {
public static final long serialVersionUID = -7046029254386353129L;
protected final Reference2FloatFunction <K> function;
protected final Object sync;
protected SynchronizedFunction( final Reference2FloatFunction <K> f, final Object sync ) {
if ( f == null ) throw new NullPointerException();
this.function = f;
this.sync = sync;
}
protected SynchronizedFunction( final Reference2FloatFunction <K> f ) {
if ( f == null ) throw new NullPointerException();
this.function = f;
this.sync = this;
}
public int size() { synchronized( sync ) { return function.size(); } }
public boolean containsKey( final Object k ) { synchronized( sync ) { return function.containsKey( k ); } }
public float defaultReturnValue() { synchronized( sync ) { return function.defaultReturnValue(); } }
public void defaultReturnValue( final float defRetValue ) { synchronized( sync ) { function.defaultReturnValue( defRetValue ); } }
public float put( final K k, final float v ) { synchronized( sync ) { return function.put( k, v ); } }
public void clear() { synchronized( sync ) { function.clear(); } }
public String toString() { synchronized( sync ) { return function.toString(); } }
public Float put( final K k, final Float v ) { synchronized( sync ) { return function.put( k, v ); } }
public Float get( final Object k ) { synchronized( sync ) { return function.get( k ); } }
public Float remove( final Object k ) { synchronized( sync ) { return function.remove( k ); } }
public float removeFloat( final Object k ) { synchronized( sync ) { return function.removeFloat( k ); } }
public float getFloat( final Object k ) { synchronized( sync ) { return function.getFloat( k ); } }
}
/** Returns a synchronized type-specific function backed by the given type-specific function.
*
* @param f the function to be wrapped in a synchronized function.
* @return a synchronized view of the specified function.
* @see java.util.Collections#synchronizedMap(java.util.Map)
*/
public static <K> Reference2FloatFunction <K> synchronize( final Reference2FloatFunction <K> f ) { return new SynchronizedFunction <K>( f ); }
/** Returns a synchronized type-specific function backed by the given type-specific function, using an assigned object to synchronize.
*
* @param f the function to be wrapped in a synchronized function.
* @param sync an object that will be used to synchronize the access to the function.
* @return a synchronized view of the specified function.
* @see java.util.Collections#synchronizedMap(java.util.Map)
*/
public static <K> Reference2FloatFunction <K> synchronize( final Reference2FloatFunction <K> f, final Object sync ) { return new SynchronizedFunction <K>( f, sync ); }
/** An unmodifiable wrapper class for functions. */
public static class UnmodifiableFunction <K> extends AbstractReference2FloatFunction <K> implements java.io.Serializable {
public static final long serialVersionUID = -7046029254386353129L;
protected final Reference2FloatFunction <K> function;
protected UnmodifiableFunction( final Reference2FloatFunction <K> f ) {
if ( f == null ) throw new NullPointerException();
this.function = f;
}
public int size() { return function.size(); }
public boolean containsKey( final Object k ) { return function.containsKey( k ); }
public float defaultReturnValue() { return defaultReturnValue(); }
public void defaultReturnValue( final float defRetValue ) { throw new UnsupportedOperationException(); }
public float put( final K k, final float v ) { throw new UnsupportedOperationException(); }
public void clear() { throw new UnsupportedOperationException(); }
public String toString() { return function.toString(); }
public float removeFloat( final Object k ) { throw new UnsupportedOperationException(); }
public float getFloat( final Object k ) { return function.getFloat( k ); }
}
/** Returns an unmodifiable type-specific function backed by the given type-specific function.
*
* @param f the function to be wrapped in an unmodifiable function.
* @return an unmodifiable view of the specified function.
* @see java.util.Collections#unmodifiableMap(java.util.Map)
*/
public static <K> Reference2FloatFunction <K> unmodifiable( final Reference2FloatFunction <K> f ) { return new UnmodifiableFunction <K>( f ); }
}
|