tapestry/tapestry-framework/src/java/org/apache/tapestry/spec/PropertySpecification.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 org.apache.hivemind.impl.BaseLocatable;

/**
 * Defines a transient or persistant property of a component or page.
 * 
 * @author Howard Lewis Ship
 * @since 3.0
 */

public class PropertySpecification extends BaseLocatable implements
        IPropertySpecification
{

    private String _name;

    private String _type;

    private boolean _isGeneric;
    
    private String _initialValue;

    private String _persistence;

    private boolean _proxyChecked;
    
    private boolean _canProxy;
    
    public String getInitialValue()
    {
        return _initialValue;
    }

    public String getName()
    {
        return _name;
    }

    public boolean isPersistent()
    {
        return _persistence != null;
    }

    /**
     * The type of property to create, or null if no type was specified. The
     * value is the name of a primitive type, a fully qualified class name, or
     * an array name for either. Type is only specified for 3.0 DTDs, in 4.0 the
     * only behavior is for the new property to match the type defined by an
     * abstract accessor, or to be java.lang.Object.
     */
    public String getType()
    {
        return _type;
    }

    public void setInitialValue(String initialValue)
    {
        _initialValue = initialValue;
    }

    /**
     * Sets the name of the property. This should not be changed once this
     * IPropertySpecification is added to a
     * {@link org.apache.tapestry.spec.ComponentSpecification}.
     */

    public void setName(String name)
    {
        _name = name;
    }

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

    public void setGeneric(boolean isGeneric)
    {
        _isGeneric = isGeneric;
    }
    
    public boolean isGeneric()
    {
        return _isGeneric;
    }
    
    /** @since 4.0 */
    public String getPersistence()
    {
        return _persistence;
    }

    /** @since 4.0 */
    public void setPersistence(String persistence)
    {
        _persistence = persistence;
    }

    /**
     * {@inheritDoc}
     */
    public boolean canProxy()
    {
        return _canProxy;
    }

    /**
     * {@inheritDoc}
     */
    public boolean isProxyChecked()
    {
        return _proxyChecked;
    }

    /**
     * {@inheritDoc}
     */
    public void setCanProxy(boolean canProxy)
    {
        _canProxy = canProxy;
    }

    /**
     * {@inheritDoc}
     */
    public void setProxyChecked(boolean checked)
    {
        _proxyChecked = checked;
    }
}