| // 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.tapestry.spec; |
| |
| import org.apache.tapestry.ILocationHolder; |
| |
| /** |
| * Defines a formal parameter to a component. An <code>IParameterSpecification</code> |
| * is contained by a {@link IComponentSpecification}. |
| * |
| * <p>TBD: Identify arrays in some way. |
| * |
| * @author glongman@intelligentworks.com |
| * @version $Id$ |
| */ |
| public interface IParameterSpecification extends ILocationHolder |
| { |
| /** |
| * Returns the class name of the expected type of the parameter. The default value |
| * is <code>java.lang.Object</code> which matches anything. |
| * |
| **/ |
| public abstract String getType(); |
| /** |
| * Returns true if the parameter is required by the component. |
| * The default is false, meaning the parameter is optional. |
| * |
| **/ |
| public abstract boolean isRequired(); |
| public abstract void setRequired(boolean value); |
| /** |
| * Sets the type of value expected for the parameter. This can be |
| * left blank to indicate any type. |
| * |
| **/ |
| public abstract void setType(String value); |
| /** |
| * Returns the documentation for this parameter. |
| * |
| * @since 1.0.9 |
| * |
| **/ |
| public abstract String getDescription(); |
| /** |
| * Sets the documentation for this parameter. |
| * |
| * @since 1.0.9 |
| * |
| **/ |
| public abstract void setDescription(String description); |
| /** |
| * Sets the property name (of the component class) |
| * to connect the parameter to. |
| * |
| **/ |
| public abstract void setPropertyName(String propertyName); |
| /** |
| * Returns the name of the JavaBeans property to connect the |
| * parameter to. |
| * |
| **/ |
| public abstract String getPropertyName(); |
| /** |
| * Returns the parameter value direction, defaulting to {@link Direction#CUSTOM} |
| * if not otherwise specified. |
| * |
| **/ |
| public abstract Direction getDirection(); |
| public abstract void setDirection(Direction direction); |
| /** |
| * Returns the default value of the JavaBeans property if no binding is provided |
| * or null if it has not been specified |
| **/ |
| public abstract String getDefaultValue(); |
| /** |
| * Sets the default value of the JavaBeans property if no binding is provided |
| * |
| **/ |
| public abstract void setDefaultValue(String defaultValue); |
| |
| } |