001    // Copyright 2008 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry5.services;
016    
017    import org.apache.tapestry5.ioc.annotations.UsesMappedConfiguration;
018    
019    /**
020     * Analyzes a session-persisted object, specifically to see if it is dirty or not.  The service implementation uses a
021     * mapped configuration to form a {@linkplain org.apache.tapestry5.ioc.services.StrategyBuilder strategy} based on
022     * object type. The service is injectable using the {@link org.apache.tapestry5.ioc.annotations.Primary} marker
023     * annotation.
024     *
025     * @see org.apache.tapestry5.annotations.ImmutableSessionPersistedObject
026     * @see org.apache.tapestry5.OptimizedSessionPersistedObject
027     * @since 5.1.0.0
028     */
029    @UsesMappedConfiguration(key = Class.class, value = SessionPersistedObjectAnalyzer.class)
030    public interface SessionPersistedObjectAnalyzer<T>
031    {
032        /**
033         * Passed an object (never null) to see if it is dirty or not. Dirty objects that are stored in the session are
034         * re-stored into the session at the end of the request.
035         *
036         * @param object
037         * @return true if object needs to be re-stored into the session
038         */
039        boolean isDirty(T object);
040    }