tapestry/tapestry-framework/src/java/org/apache/tapestry/spec/BeanLifecycle.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;

/**
 * An enumeration of the different possible lifecycles for a JavaBean.
 * 
 * @author Howard Lewis Ship
 * @since 1.0.4
 */

public final class BeanLifecycle
{
    /**
     * No lifecycle; the bean is created fresh on each reference and not retained.
     */

    public static final BeanLifecycle NONE = new BeanLifecycle("NONE");

    /**
     * The standard lifecycle; the bean is retained for the duration of the request cycle and is
     * discarded at the end of the request cycle.
     */

    public static final BeanLifecycle REQUEST = new BeanLifecycle("REQUEST");

    /**
     * The bean is created once and reused for the lifespan of the page containing the component.
     */

    public static final BeanLifecycle PAGE = new BeanLifecycle("PAGE");

    /**
     * The bean is create and reused until the end of the current render, at which point it is
     * discarded.
     * 
     * @since 2.2
     */

    public static final BeanLifecycle RENDER = new BeanLifecycle("RENDER");

    private final String _name;

    private BeanLifecycle(String name)
    {
        _name = name;
    }

    public String toString()
    {
        return "BeanLifecycle[" + _name + "]";
    }

    public String getName()
    {
        return _name;
    }

}