org.apache.felix.webconsole.DefaultVariableResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.apache.felix.webconsole Show documentation

Web Based Management Console for OSGi Frameworks. See http://felix.apache.org/site/apache-felix-web-console.html for more information on this bundle.

There is a newer version: 5.0.8

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.felix.webconsole;


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


/**
 * The DefaultVariableResolver is a HashMap based
 * default implementation of the {@link VariableResolver} interface. It may
 * be used by plugins to implement the interface for the request and is also
 * used by the
 * {@link WebConsoleUtil#getVariableResolver(javax.servlet.ServletRequest)}
 * as the variable resolver if none has yet been assigned to the request.
 */
public class DefaultVariableResolver extends HashMap implements VariableResolver
{

    private static final long serialVersionUID = 4148807223433047780L;


    /**
     * Creates a new variable resolver with default capacity.
     */
    public DefaultVariableResolver()
    {
        super();
    }


    /**
     * Creates a new variable resolver and initializes both - capacity & load factor
     * 
     * @param initialCapacity  the initial capacity of the variable container
     * @param loadFactor the load factor of the variable container
     * @see HashMap#HashMap(int, float)
     */
    public DefaultVariableResolver( final int initialCapacity, final float loadFactor )
    {
        super( initialCapacity, loadFactor );
    }


    /**
     * Creates a new variable resolver with specified initial capacity
     * 
     * @param initialCapacity  the initial capacity of the variable container
     * @see HashMap#HashMap(int)
     */
    public DefaultVariableResolver( final int initialCapacity )
    {
        super( initialCapacity );
    }


    /**
     * Creates a new variable resolver copying the variables from the given map.
     * 
     * @param source  the map whose variables are to be placed in this resolver.
     * @see HashMap#HashMap(Map)
     */
    public DefaultVariableResolver( final Map source )
    {
        super( source );
    }


    /**
     * Returns the string representation of the value stored under the variable
     * name in this map. If no value is stored under the variable name,
     * null is returned.
     *
     * @param variable The name of the variable whose value is to be returned.
     * @return The variable value or null if there is no entry
     *      with the given name in this map.
     */
    public String resolve( final String variable )
    {
        Object value = get( variable );
        if ( value != null )
        {
            return value.toString();
        }
        return null;
    }

}