package org.apache.maven.app;

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *    "Apache Maven" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Apache Maven", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 * ====================================================================
 */

//import org.apache.commons.grant.PropsHandler;

import java.util.Hashtable;

/** Implementation of a Commons Grant <code>propsHandler</code>
 *  to resolve through Jelly's context.
 *
 *  @author <a href="mailto:bob@eng.werken.com">bob mcwhirter</a>
 */
public class GrantPropsHandler implements PropsHandler
{
    /** JellyContext wrapped to provide Hashtable interface. */
    private Hashtable props;

    /** The JellyContext. */
    private MavenJellyContext context;

    /** Construct with a backing-store <code>JellyContext</code>
     *
     *  @param context The backing-store <code>JellyContext</code>.
     */
    public GrantPropsHandler(MavenJellyContext context)
    {
        this.context = context;
    }

    /** Set an ant property.
     *
     *  @param name The property name.
     *  @param value The property value.
     */
    public void setProperty(String name, String value)
    {
        context.setScopedVariable(name,
                                  value);
    }

    /** Retrieve an ant property.
     *
     *  @param name The property name.
     *
     *  @return The property value.
     */
    public String getProperty(String name)
    {
        Object value = context.getScopedVariable(name);

        if (value == null)
        {
            return null;
        }

        return value.toString();
    }

    /** Set a new ant property.
     *
     *  <p>
     *  Following the ant spec, this sets a property
     *  only if it has not been previously set.  If
     *  the property has already been set, this returns
     *  silently.
     *  </p>
     *
     *  @param name The property name.
     *  @param value The property value.
     */
    public void setNewProperty(String name, String value)
    {
        if (context.getScopedVariable(name) == null)
        {
            context.setScopedVariable(name,
                                      value);
        }
    }

    /** Set an ant user property.
     *
     *  @param name The property name.
     *  @param value The property value.
     */
    public void setUserProperty(String name, String value)
    {
        context.setScopedVariable(name,
                                  value);
    }


    public void setInheritedProperty(String name, String value)
    {
        context.setScopedVariable(name,
                                  value);
    }

    /** Retrieve an ant user property.
     *
     *  @param name The property name.
     *
     *  @return The property value.
     */
    public String getUserProperty(String name)
    {
        Object value = context.getScopedVariable(name);

        if (value == null)
        {
            return null;
        }

        return value.toString();
    }

    /** Internal ant property-setting implementation.
     *
     *  @param name The property name.
     *  @param value The property value.
     */
    public void setPropertyInternal(String name, String value)
    {
        if (null != getUserProperty(name))
        {
            return;
        }
        setProperty(name, value);
    }

    /** Retrieve all ant properties.
     *
     *  @return A <code>Hashtable</code> of all properties.
     */
    public Hashtable getProperties()
    {
        return this.context.asProperties();
    }

    /** Retrieve all ant user properties.
     *
     *  @return A <code>Hashtable</code> of all user properties.
     */
    public Hashtable getUserProperties()
    {
        return this.context.asProperties();
    }
}