org.codehaus.mojo.versions.UpdatePropertiesMojo Maven / Gradle / Ivy
package org.codehaus.mojo.versions;
/*
* 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.
*/
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.codehaus.mojo.versions.api.ArtifactAssociation;
import org.codehaus.mojo.versions.api.PropertyVersions;
import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
import javax.xml.stream.XMLStreamException;
import java.util.Map;
/**
* Sets properties to the latest versions of specific artifacts.
*
* @author Stephen Connolly
* @since 1.0-alpha-1
*/
@Mojo( name = "update-properties", requiresProject = true, requiresDirectInvocation = true )
public class UpdatePropertiesMojo
extends AbstractVersionsDependencyUpdaterMojo
{
// ------------------------------ FIELDS ------------------------------
/**
* Any restrictions that apply to specific properties.
*
* @since 1.0-alpha-3
*/
@Parameter
private Property[] properties;
/**
* A comma separated list of properties to update.
*
* @since 1.0-alpha-1
*/
@Parameter( property = "includeProperties" )
private String includeProperties = null;
/**
* A comma separated list of properties to not update.
*
* @since 1.0-alpha-1
*/
@Parameter( property = "excludeProperties" )
private String excludeProperties = null;
/**
* Whether properties linking versions should be auto-detected or not.
*
* @since 1.0-alpha-2
*/
@Parameter( property = "autoLinkItems", defaultValue = "true" )
private boolean autoLinkItems;
/**
* If a property points to a version like 1.2.3-SNAPSHOT and your repo contains a version like
* 1.1.0 without settings this to true the property will not being changed.
*
* @since 3.0.0
*/
@Parameter( property = "allowDowngrade", defaultValue = "false" )
private boolean allowDowngrade;
/**
* Whether to allow the major version number to be changed.
*
* @since 2.4
*/
@Parameter( property = "allowMajorUpdates", defaultValue = "true" )
protected Boolean allowMajorUpdates;
/**
* Whether to allow the minor version number to be changed.
*
* @since 2.4
*/
@Parameter( property = "allowMinorUpdates", defaultValue = "true" )
protected Boolean allowMinorUpdates;
/**
* Whether to allow the incremental version number to be changed.
*
* @since 2.4
*/
@Parameter( property = "allowIncrementalUpdates", defaultValue = "true" )
protected Boolean allowIncrementalUpdates;
// -------------------------- STATIC METHODS --------------------------
// -------------------------- OTHER METHODS --------------------------
/**
* @param pom the pom to update.
* @throws MojoExecutionException when things go wrong
* @throws MojoFailureException when things go wrong in a very bad way
* @throws XMLStreamException when things go wrong with XML streaming
* @see AbstractVersionsUpdaterMojo#update(ModifiedPomXMLEventReader)
* @since 1.0-alpha-1
*/
protected void update( ModifiedPomXMLEventReader pom )
throws MojoExecutionException, MojoFailureException, XMLStreamException
{
Map propertyVersions =
this.getHelper().getVersionPropertiesMap( getProject(), properties, includeProperties, excludeProperties,
autoLinkItems );
for ( Map.Entry entry : propertyVersions.entrySet() )
{
Property property = entry.getKey();
PropertyVersions version = entry.getValue();
final String currentVersion = getProject().getProperties().getProperty( property.getName() );
if ( currentVersion == null )
{
continue;
}
boolean canUpdateProperty = true;
for ( ArtifactAssociation association : version.getAssociations() )
{
if ( !( isIncluded( association.getArtifact() ) ) )
{
getLog().info( "Not updating the property ${" + property.getName()
+ "} because it is used by artifact " + association.getArtifact().toString()
+ " and that artifact is not included in the list of " + " allowed artifacts to be updated." );
canUpdateProperty = false;
break;
}
}
if ( canUpdateProperty )
{
int segment =
determineUnchangedSegment( allowMajorUpdates, allowMinorUpdates, allowIncrementalUpdates );
updatePropertyToNewestVersion( pom, property, version, currentVersion, allowDowngrade, segment );
}
}
}
}