001    package org.apache.maven.model.profile.activation;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import org.apache.maven.model.Profile;
023    import org.apache.maven.model.building.ModelProblemCollector;
024    import org.apache.maven.model.profile.ProfileActivationContext;
025    
026    /**
027     * Determines whether a profile should be activated.
028     * 
029     * @author Benjamin Bentmann
030     */
031    public interface ProfileActivator
032    {
033    
034        /**
035         * Determines whether the specified profile is active in the given activator context.
036         * 
037         * @param profile The profile whose activation status should be determined, must not be {@code null}.
038         * @param context The environmental context used to determine the activation status of the profile, must not be
039         *            {@code null}.
040         * @param problems The container used to collect problems (e.g. bad syntax) that were encountered, must not be
041         *            {@code null}.
042         * @return {@code true} if the profile is active, {@code false} otherwise.
043         */
044        boolean isActive( Profile profile, ProfileActivationContext context, ModelProblemCollector problems );
045    
046    }