tapestry/tapestry-framework/src/java/org/apache/tapestry/spec/ParameterSpecification.java

// Copyright 2004, 2005 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.tapestry.spec;

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;

import org.apache.hivemind.HiveMind;
import org.apache.hivemind.impl.BaseLocatable;
import org.apache.hivemind.util.Defense;
import org.apache.tapestry.TapestryUtils;

/**
 * Defines a formal parameter to a component. A
 * <code>IParameterSpecification</code> is contained by a
 * {@link IComponentSpecification}.
 * <p>
 * TBD: Identify arrays in some way.
 * 
 * @author Howard Lewis Ship
 */

public class ParameterSpecification extends BaseLocatable implements
        IParameterSpecification
{

    private boolean _required = false;

    private String _type;

    /** @since 1.0.9 */
    private String _description;

    /** @since 2.0.3 */
    private String _propertyName;

    /** @since 3.0 */
    private String _defaultValue;

    /** @since 4.0 */
    private boolean _cache = true;

    /** @since 4.0 */
    private Collection _aliasNames = Collections.EMPTY_LIST;

    /** @since 4.0 */
    private String _parameterName;

    /** @since 4.0 */
    private boolean _deprecated = false;

    /**
     * Returns the class name of the expected type of the parameter. The default
     * value is <code>java.lang.Object</code> which matches anything.
     */

    public String getType()
    {
        return _type;
    }

    /**
     * Returns true if the parameter is required by the component. The default
     * is false, meaning the parameter is optional.
     */

    public boolean isRequired()
    {
        return _required;
    }

    public void setRequired(boolean value)
    {
        _required = value;
    }

    /**
     * Sets the type of value expected for the parameter. This can be left blank
     * to indicate any type.
     */

    public void setType(String value)
    {
        _type = value;
    }

    /**
     * Returns the documentation for this parameter.
     * 
     * @since 1.0.9
     */

    public String getDescription()
    {
        return _description;
    }

    /**
     * Sets the documentation for this parameter.
     * 
     * @since 1.0.9
     */

    public void setDescription(String description)
    {
        _description = description;
    }

    /**
     * Sets the property name (of the component class) to connect the parameter
     * to.
     */

    public void setPropertyName(String propertyName)
    {
        _propertyName = propertyName;
    }

    /**
     * Returns the name of the JavaBeans property to connect the parameter to.
     */

    public String getPropertyName()
    {
        return _propertyName;
    }

    /**
     * @see org.apache.tapestry.spec.IParameterSpecification#getDefaultValue()
     */
    public String getDefaultValue()
    {
        return _defaultValue;
    }

    /**
     * @see org.apache.tapestry.spec.IParameterSpecification#setDefaultValue(java.lang.String)
     */
    public void setDefaultValue(String defaultValue)
    {
        _defaultValue = defaultValue;
    }

    /** @since 4.0 */
    public boolean getCache()
    {
        return _cache;
    }

    /** @since 4.0 */
    public void setCache(boolean cache)
    {
        _cache = cache;
    }

    /** @since 4.0 */
    public Collection getAliasNames()
    {
        return _aliasNames;
    }

    /** @since 4.0 */
    public String getParameterName()
    {
        return _parameterName;
    }

    /** @since 4.0 */
    public void setAliases(String nameList)
    {
        if (HiveMind.isNonBlank(nameList))
        {
            String[] names = TapestryUtils.split(nameList);

            _aliasNames = Arrays.asList(names);
        }
    }

    /** @since 4.0 */
    public void setParameterName(String name)
    {
        Defense.notNull(name, "name");

        _parameterName = name;
    }

    /** @since 4.0 */
    public boolean isDeprecated()
    {
        return _deprecated;
    }

    /** @since 4.0 */
    public void setDeprecated(boolean deprecated)
    {
        _deprecated = deprecated;
    }

}