AbstractLifecycleHandler.java

package org.codehaus.plexus.lifecycle;

/*
 * Copyright 2001-2006 Codehaus 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.
 */

import org.codehaus.plexus.classworlds.realm.ClassRealm;
import org.codehaus.plexus.component.manager.ComponentManager;
import org.codehaus.plexus.lifecycle.phase.Phase;
import org.codehaus.plexus.personality.plexus.lifecycle.phase.PhaseExecutionException;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

public abstract class AbstractLifecycleHandler
    implements LifecycleHandler
{
    private List<Phase> beginSegment;

    private List<Phase> endSegment;

    // ----------------------------------------------------------------------
    // Begin Segment
    // ----------------------------------------------------------------------

    public void addBeginSegment( Phase phase )
    {
        if ( beginSegment == null )
        {
            beginSegment = new ArrayList<Phase>();
        }

        beginSegment.add( phase );
    }

    public List<Phase> getBeginSegment()
    {
        return beginSegment;
    }

    public void addEndSegment( Phase phase )
    {
        if ( endSegment == null )
        {
            endSegment = new ArrayList<Phase>();
        }

        endSegment.add( phase );
    }

    public List<Phase> getEndSegment()
    {
        return endSegment;
    }

    // ----------------------------------------------------------------------
    // Lifecylce Management
    // ----------------------------------------------------------------------

    /**
     * @deprecated
     */
    public void start( Object component, ComponentManager manager )
        throws PhaseExecutionException
    {
        start( component, manager, manager.getContainer().getLookupRealm( component ) );
    }

    /**
     * Start a component's lifecycle.
     */
    public void start( Object component, ComponentManager manager, ClassRealm realm  )
        throws PhaseExecutionException
    {
        if ( segmentIsEmpty( getBeginSegment() ) )
        {
            return;
        }

        for ( Phase phase : getBeginSegment() )
        {
            phase.execute( component, manager, realm );
        }
    }

    /**
     * End a component's lifecycle.
     * @deprecated
     */
    public void end( Object component, ComponentManager manager )
        throws PhaseExecutionException
    {
        end( component, manager, manager.getContainer().getLookupRealm( component ) );
    }

    /**
     * End a component's lifecycle.
     */
    public void end( Object component, ComponentManager manager, ClassRealm contextRealm )
        throws PhaseExecutionException
    {
        if ( segmentIsEmpty( getEndSegment() ) )
        {
            return;
        }

        for ( Phase phase : getEndSegment() )
        {
            phase.execute( component, manager, contextRealm );
        }
    }

    private boolean segmentIsEmpty( List<Phase> segment )
    {
        if ( segment == null || segment.size() == 0 )
        {
            return true;
        }

        return false;
    }
}