groovyx.net.http.StringHashMap Maven / Gradle / Ivy

/*
 * Copyright 2008-2011 Thomas Nichols.  http://blog.thomnichols.org
 *
 * 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.
 *
 * You are receiving this code free of charge, which represents many hours of
 * effort from other individuals and corporations.  As a responsible member
 * of the community, you are encouraged (but not required) to donate any
 * enhancements or improvements back to the community under a similar open
 * source license.  Thank you. -TMN
 */
package groovyx.net.http;

import java.util.HashMap;
import java.util.Map;

/**
 * Converts keys to strings, mainly to normalize the difference between
 * GString and String keys since a GString will not produce the same hashcode as
 * its equivalent string.
 *
 * Basically, any given key will always be coerced to a String, and any retrieved
 * key (either via {@link #keySet()} or {@link #entrySet()} will always be a
 * String.
 * @author Tom Nichols
 */
class StringHashMap extends HashMap {

    private static final long serialVersionUID = -92935672093270924L;

    public StringHashMap() { super(); }

    public StringHashMap( Map contents ) {
        super();
        this.putAll( contents );
    }

    @Override
    public boolean containsKey( Object key ) {
        if ( key == null ) return false;
        return super.containsKey( key.toString() );
    }

    @Override
    public V get( Object key ) {
        if ( key == null ) return null;
        return super.get( key.toString() );
    }

    public V put(Object key, V value) {
        return key != null ? super.put( key.toString(), value ) : value;
    }

    @Override
    public void putAll( Map m ) {
        for ( Object key : m.keySet() ) this.put(  key, m.get( key ) );
    }

    @Override
    public V remove( Object key ) {
        if ( key == null ) return null;
        return super.remove( key.toString() );
    }
}