trove4j-commit Mailing List for Trove for Java (Page 8)

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/trove4j/trove/src/gnu/trove
In directory ddv4jf1.ch3.sourceforge.com:/tmp/cvs-serv28043/src/gnu/trove

Added Files:
      Tag: TROVE_3_WORKING
	Builder.java 
Log Message:
Builder pattern initial implementation and associated changes.

--- NEW FILE: Builder.java ---
///////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2008, Robert D. Eden All Rights Reserved.
// Copyright (c) 2009, Jeff Randall All Rights Reserved.
//
// 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 General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
///////////////////////////////////////////////////////////////////////////////

package gnu.trove;

import gnu.trove.impl.Constants;

/**
 * Configuration object to allow setting of all of the optional parameters
 * for the various Trove collections and maps and keep the constructors
 * manageable.
 */
public class Builder<K, V> {

    private int initial_capacity;
    private float load_factor;

    private K no_entry_key;
    private V no_entry_value;

    /**
     * Use the default values when none are provided.  Individal constructors
     * for primitive classes will use the appropriate default key and value for
     * their primitive type.
     */
    public Builder() {
        initial_capacity = Constants.DEFAULT_CAPACITY;
        load_factor = Constants.DEFAULT_LOAD_FACTOR;
        no_entry_key = null;
        no_entry_value = null;
    }

    /**
     * Provide the values for all of the optional information to be provided
     * to the constructors.  Primitive collections should use the appropriate
     * Value class for each type.  The <tt>no_entry_key</tt> parameter is only
     * used by the various Trove maps.
     *
     * @param initial_capacity the initial capacity desired.
     * @param load_factor the load factor to use (when applicable)
     * @param no_entry_key the value to use for invalid keys (only applies to Maps)
     * @param no_entry_value the value to use to non-existing values in maps and all other collections.
     */
    public Builder( int initial_capacity, float load_factor, K no_entry_key, V no_entry_value ) {
        this.initial_capacity = initial_capacity;

        if ( load_factor < 0.0f ) load_factor = 0.0f;
        if ( load_factor > 1.0f ) load_factor = 1.0f;
        this.load_factor = load_factor;

        this.no_entry_key = no_entry_key;
        this.no_entry_value = no_entry_value;
    }

    /**
     * Get the collection's initial capacity.
     *
     * @return the initial capacity requested.
     */
    public int getInitialCapacity() {
        return initial_capacity;
    }

    /**
     * Set the collection's initial capacity.
     *
     * @param initial_capacity the collection's initial capacity.
     * @return the instance to allow for call chaining.
     */
    public Builder<K,V> setInitialCapacity( int initial_capacity ) {
        this.initial_capacity = initial_capacity;
        return this;
    }

    /**
     * Get the desired load factor.
     *
     * @return a float value between 0.0f and 1.0f that is the load factor
     *         requested.
     */
    public float getLoadFactor() {
        return load_factor;
    }

    /**
     * Set the desired load factor.
     *
     * @param load_factor a float value between 0.0f and 1.0f
     * @return the instance to allow for call chaining.
     */
    public Builder<K,V> setLoadFactor( float load_factor ) {
        if ( load_factor < 0.0f ) load_factor = 0.0f;
        if ( load_factor > 1.0f ) load_factor = 1.0f;
        this.load_factor = load_factor;
        return this;
    }

    /**
     * The value that represents no entry in Trove map's keySet().
     *
     * @return the value that represents null for Keys.
     */
    public K getNoEntryKey() {
        return no_entry_key;
    }

    /**
     * Maps with primitive keys should use the appropriate Value Object
     * type
     *
     * @param no_entry_key the value that represents null for Trove map's keySet().
     * @return the instance to allow for call chaining.
     */
    public Builder<K,V> setNoEntryKey( K no_entry_key ) {
        this.no_entry_key = no_entry_key;
        return this;
    }

    /**
     * The value that represents null in various Trove maps and collections.
     *
     * @return the value that represents null for values in maps and collections.
     */
    public V getNoEntryValue() {
        return no_entry_value;
    }

    /**
     * The value that represents null for values in Trove maps and collections.
     *
     * @param no_entry_value the value that represents null for Trove maps and collections.
     * @return the instance to allow for call chaining.
     */
    public Builder<K,V> setNoEntryValue( V no_entry_value ) {
        this.no_entry_value = no_entry_value;
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public boolean equals( Object o ) {
        if ( this == o ) return true;
        if ( o == null || getClass() != o.getClass() ) return false;

        Builder builder = ( Builder ) o;

        if ( initial_capacity != builder.initial_capacity ) return false;
        if ( Float.compare( builder.load_factor, load_factor ) != 0 ) return false;

        if ( no_entry_key != null ?
                !no_entry_key.equals( builder.no_entry_key ) :
                builder.no_entry_key != null )
            return false;

        //noinspection simplify
        return !(no_entry_value != null ?
                !no_entry_value.equals(builder.no_entry_value) :
                builder.no_entry_value != null);

    }

    /** {@inheritDoc} */
    @Override
    public int hashCode() {
        int result = initial_capacity;
        result = 31 * result + ( load_factor != +0.0f ? Float.floatToIntBits( load_factor ) : 0 );
        result = 31 * result + ( no_entry_key != null ? no_entry_key.hashCode() : 0 );
        result = 31 * result + ( no_entry_value != null ? no_entry_value.hashCode() : 0 );
        return result;
    }

    /** {@inheritDoc} */
    @Override
    public String toString() {
        return "Builder{" +
                "initial_capacity=" + initial_capacity +
                ", load_factor=" + load_factor +
                ", no_entry_key=" + no_entry_key +
                ", no_entry_value=" + no_entry_value +
                '}';
    }
}

2002	Jan (14)	Feb	Mar	Apr (6)	May	Jun (3)	Jul (3)	Aug (6)	Sep (14)	Oct	Nov	Dec
2003	Jan (1)	Feb	Mar (7)	Apr	May	Jun	Jul (4)	Aug (2)	Sep (3)	Oct	Nov (7)	Dec (3)
2004	Jan	Feb (3)	Mar (2)	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov (4)	Dec
2005	Jan	Feb	Mar (11)	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec (7)
2006	Jan	Feb	Mar	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov (29)	Dec (16)
2007	Jan (11)	Feb (6)	Mar (12)	Apr (2)	May	Jun (16)	Jul (9)	Aug (5)	Sep	Oct (4)	Nov (8)	Dec
2008	Jan	Feb	Mar	Apr (9)	May (23)	Jun	Jul	Aug (5)	Sep	Oct (11)	Nov (2)	Dec (3)
2009	Jan	Feb (2)	Mar (15)	Apr	May	Jun (2)	Jul	Aug (65)	Sep (180)	Oct (52)	Nov (33)	Dec
2010	Jan (5)	Feb (3)	Mar (24)	Apr	May	Jun	Jul	Aug	Sep (49)	Oct	Nov	Dec

trove4j-commit Mailing List for Trove for Java (Page 8)

trove4j-commit — commit logs for trove CVS projects