/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2004 The Apache Software Foundation
*
* 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 org.apache.catalina.util;
/* START PWC 6057385
import java.util.HashMap;
*/
// START PWC 6057385
import org.apache.catalina.core.StandardServer;
import org.glassfish.logging.annotation.LogMessageInfo;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.ResourceBundle;
/**
* Extended implementation of <strong>HashMap</strong> that includes a
* <code>locked</code> property. This class can be used to safely expose
* Catalina internal parameter map objects to user classes without having
* to clone them in order to avoid modifications. When first created, a
* <code>ParmaeterMap</code> instance is not locked.
*
* @author Craig R. McClanahan
* @version $Revision: 1.2 $ $Date: 2005/12/08 01:28:18 $
*/
/* START PWC 6057385
public final class ParameterMap extends HashMap {
*/
// START PWC 6057385
public final class ParameterMap<K,V> extends LinkedHashMap<K,V> {
// END PWC 6057385
private static final ResourceBundle rb = StandardServer.log.getResourceBundle();
@LogMessageInfo(
message = "Map is currently locked",
level = "WARNING"
)
public static final String MAP_IS_LOCKED_EXCEPTION = "AS-WEB-CORE-00489";
// ----------------------------------------------------------- Constructors
/**
* Construct a new, empty map with the default initial capacity and
* load factor.
*/
public ParameterMap() {
super();
}
/**
* Construct a new, empty map with the specified initial capacity and
* default load factor.
*
* @param initialCapacity The initial capacity of this map
*/
public ParameterMap(int initialCapacity) {
super(initialCapacity);
}
/**
* Construct a new, empty map with the specified initial capacity and
* load factor.
*
* @param initialCapacity The initial capacity of this map
* @param loadFactor The load factor of this map
*/
public ParameterMap(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor);
}
/**
* Construct a new map with the same mappings as the given map.
*
* @param map Map whose contents are duplicated in the new map
*/
public ParameterMap(Map<K,V> map) {
super(map);
}
// ------------------------------------------------------------- Properties
/**
* The current lock state of this parameter map.
*/
private boolean locked = false;
/**
* Return the locked state of this parameter map.
*/
public boolean isLocked() {
return (this.locked);
}
/**
* Set the locked state of this parameter map.
*
* @param locked The new locked state
*/
public void setLocked(boolean locked) {
this.locked = locked;
}
// --------------------------------------------------------- Public Methods
/**
* Remove all mappings from this map.
*
* @exception IllegalStateException if this map is currently locked
*/
@Override
public void clear() {
if (locked)
throw new IllegalStateException
(rb.getString(MAP_IS_LOCKED_EXCEPTION));
super.clear();
}
/**
* Associate the specified value with the specified key in this map. If
* the map previously contained a mapping for this key, the old value is
* replaced.
*
* @param key Key with which the specified value is to be associated
* @param value Value to be associated with the specified key
*
* @return The previous value associated with the specified key, or
* <code>null</code> if there was no mapping for key
*
* @exception IllegalStateException if this map is currently locked
*/
@Override
public V put(K key, V value) {
if (locked)
throw new IllegalStateException
(rb.getString(MAP_IS_LOCKED_EXCEPTION));
return (super.put(key, value));
}
/**
* Copy all of the mappings from the specified map to this one. These
* mappings replace any mappings that this map had for any of the keys
* currently in the specified Map.
*
* @param map Mappings to be stored into this map
*
* @exception IllegalStateException if this map is currently locked
*/
@Override
public void putAll(Map<? extends K,? extends V> map) {
if (locked)
throw new IllegalStateException
(rb.getString(MAP_IS_LOCKED_EXCEPTION));
super.putAll(map);
}
/**
* Remove the mapping for this key from the map if present.
*
* @param key Key whose mapping is to be removed from the map
*
* @return The previous value associated with the specified key, or
* <code>null</code> if there was no mapping for that key
*
* @exception IllegalStateException if this map is currently locked
*/
@Override
public V remove(Object key) {
if (locked)
throw new IllegalStateException
(rb.getString(MAP_IS_LOCKED_EXCEPTION));
return (super.remove(key));
}
}