org.apache.maven.plugin.lifecycle.Lifecycle Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-plugin-api Show documentation

The API for plugins - Mojos - development.

There is a newer version: 4.0.0-rc-4

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.maven.plugin.lifecycle;

/**
 *
 *         A custom lifecycle mapping definition.
 *
 *
 * @version $Revision$ $Date$
 */
@SuppressWarnings("all")
public class Lifecycle implements java.io.Serializable {

    // --------------------------/
    // - Class/Member Variables -/
    // --------------------------/

    /**
     * The ID of this lifecycle, for identification in the mojo
     * descriptor.
     */
    private String id;

    /**
     * Field phases.
     */
    private java.util.List phases;

    // -----------/
    // - Methods -/
    // -----------/

    /**
     * Method addPhase.
     *
     * @param phase a phase object.
     */
    public void addPhase(Phase phase) {
        getPhases().add(phase);
    } // -- void addPhase( Phase )

    /**
     * Get the ID of this lifecycle, for identification in the mojo
     * descriptor.
     *
     * @return String
     */
    public String getId() {
        return this.id;
    } // -- String getId()

    /**
     * Method getPhases.
     *
     * @return List
     */
    public java.util.List getPhases() {
        if (this.phases == null) {
            this.phases = new java.util.ArrayList();
        }

        return this.phases;
    } // -- java.util.List getPhases()

    /**
     * Method removePhase.
     *
     * @param phase a phase object.
     */
    public void removePhase(Phase phase) {
        getPhases().remove(phase);
    } // -- void removePhase( Phase )

    /**
     * Set the ID of this lifecycle, for identification in the mojo
     * descriptor.
     *
     * @param id a id object.
     */
    public void setId(String id) {
        this.id = id;
    } // -- void setId( String )

    /**
     * Set the phase mappings for this lifecycle.
     *
     * @param phases a phases object.
     */
    public void setPhases(java.util.List phases) {
        this.phases = phases;
    } // -- void setPhases( java.util.List )
}