Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[MNG-6150] Javadoc improvements for 3.5.0 

* Remove duplicate plugin configuration
* Add workaround for Javadoc locale
* Clean up errors reported by Javadoc 7

Note: Javadoc 8 fails immediately because Modello generates invalid
Javadoc
This commit is contained in:
Michael Osipov 2017-02-12 01:10:50 +01:00
parent f8ab2a650f
commit b66bdb9cbc
82 changed files with 189 additions and 210 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
maven-artifact/src/main/java/org/apache/maven/artifact/Artifact.java
View File

@ -48,7 +48,7 @@ public interface Artifact
Pattern VERSION_FILE_PATTERN = Pattern.compile( "^(.*)-([0-9]{8}.[0-9]{6})-([0-9]+)$" );
// TODO: into artifactScope handler
// TODO into artifactScope handler
String SCOPE_COMPILE = "compile";

1
maven-artifact/src/main/java/org/apache/maven/artifact/repository/ArtifactRepository.java
View File

@ -79,7 +79,6 @@ public interface ArtifactRepository
/**
*
* @param artifact
* @return
* @since 3.0-alpha-3
*/
Artifact find( Artifact artifact );

4
maven-artifact/src/main/java/org/apache/maven/artifact/versioning/VersionRange.java
View File

@ -295,7 +295,7 @@ else if ( restriction.recommendedVersion != null )
// original recommended version
version = restriction.recommendedVersion;
}
/* TODO: should throw this immediately, but need artifact
/* TODO should throw this immediately, but need artifact
else
{
throw new OverConstrainedVersionException( "Restricting incompatible version ranges" );
@ -518,7 +518,7 @@ public String toString()
public ArtifactVersion matchVersion( List<ArtifactVersion> versions )
{
// TODO: could be more efficient by sorting the list and then moving along the restrictions in order?
// TODO could be more efficient by sorting the list and then moving along the restrictions in order?
ArtifactVersion matched = null;
for ( ArtifactVersion version : versions )

6
maven-artifact/src/main/java/org/apache/maven/repository/Proxy.java
View File

@ -148,9 +148,9 @@ public void setUserName( String userName )
}
/**
* Get the type of the proxy server.
* Get the protocol of the proxy server.
*
* @return the type of the proxy server
* @return the protocol of the proxy server
*/
public String getProtocol()
{
@ -158,7 +158,7 @@ public String getProtocol()
}
/**
* @param type the type of the proxy server like <i>SOCKSv4</i>
* @param protocol the protocol of the proxy server like <i>SOCKSv4</i>
*/
public void setProtocol( String protocol )
{

8
maven-artifact/src/main/java/org/apache/maven/repository/legacy/metadata/ArtifactMetadata.java
View File

@ -26,8 +26,8 @@
* Contains metadata about an artifact, and methods to retrieve/store it from an artifact repository.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @todo merge with artifactmetadatasource
* @todo retrieval exception not appropriate for store
* TODO merge with artifactmetadatasource
* TODO retrieval exception not appropriate for store
*/
public interface ArtifactMetadata
{
@ -64,7 +64,7 @@ public interface ArtifactMetadata
* Merge a new metadata set into this piece of metadata.
*
* @param metadata the new metadata
* @todo this should only be needed on the repository metadata
* TODO this should only be needed on the repository metadata
*/
void merge( ArtifactMetadata metadata );
@ -73,7 +73,7 @@ public interface ArtifactMetadata
*
* @param localRepository the local repository
* @param remoteRepository the remote repository it came from
* @todo this should only be needed on the repository metadata
* TODO this should only be needed on the repository metadata
*/
void storeInLocalRepository( ArtifactRepository localRepository,
ArtifactRepository remoteRepository )

4
maven-artifact/src/test/java/org/apache/maven/artifact/versioning/VersionRangeTest.java
View File

@ -178,7 +178,7 @@ public void testIntersections()
VersionRange range1 = VersionRange.createFromVersionSpec( "1.0" );
VersionRange range2 = VersionRange.createFromVersionSpec( "1.1" );
VersionRange mergedRange = range1.restrict( range2 );
// TODO: current policy is to retain the original version - is this correct, do we need strategies or is that handled elsewhere?
// TODO current policy is to retain the original version - is this correct, do we need strategies or is that handled elsewhere?
// assertEquals( CHECK_VERSION_RECOMMENDATION, "1.1", mergedRange.getRecommendedVersion().toString() );
assertEquals( CHECK_VERSION_RECOMMENDATION, "1.0", mergedRange.getRecommendedVersion().toString() );
List<Restriction> restrictions = mergedRange.getRestrictions();
@ -199,7 +199,7 @@ public void testIntersections()
assertNull( CHECK_UPPER_BOUND, restriction.getUpperBound() );
assertFalse( CHECK_UPPER_BOUND_INCLUSIVE, restriction.isUpperBoundInclusive() );
// TODO: test reversed restrictions on all below
// TODO test reversed restrictions on all below
range1 = VersionRange.createFromVersionSpec( "[1.0,)" );
range2 = VersionRange.createFromVersionSpec( "1.1" );
mergedRange = range1.restrict( range2 );

2
maven-compat/src/main/java/org/apache/maven/artifact/ArtifactScopeEnum.java
View File

@ -49,8 +49,6 @@ int getId()
/**
* Helper method to simplify null processing
*
* @return
*/
public static final ArtifactScopeEnum checkScope( ArtifactScopeEnum scope )
{

2
maven-compat/src/main/java/org/apache/maven/artifact/manager/DefaultWagonManager.java
View File

@ -166,7 +166,7 @@ public ArtifactRepository getMirrorRepository( ArtifactRepository repository )
String id = mirror.getId();
if ( id == null )
{
// TODO: this should be illegal in settings.xml
// TODO this should be illegal in settings.xml
id = repository.getId();
}

10
maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/DefaultRepositoryMetadataManager.java
View File

@ -165,7 +165,7 @@ else if ( localCopyLastModified != null && !policy.checkOutOfDate( localCopyLast
}
}
// TODO: should this be inside the above check?
// TODO should this be inside the above check?
// touch file so that this is not checked again until interval has passed
if ( file.exists() )
{
@ -196,9 +196,9 @@ private void mergeMetadata( RepositoryMetadata metadata, List<ArtifactRepository
ArtifactRepository localRepository )
throws RepositoryMetadataStoreException
{
// TODO: currently this is first wins, but really we should take the latest by comparing either the
// TODO currently this is first wins, but really we should take the latest by comparing either the
// snapshot timestamp, or some other timestamp later encoded into the metadata.
// TODO: this needs to be repeated here so the merging doesn't interfere with the written metadata
// TODO this needs to be repeated here so the merging doesn't interfere with the written metadata
// - we'd be much better having a pristine input, and an ongoing metadata for merging instead
Map<ArtifactRepository, Metadata> previousMetadata = new HashMap<>();
@ -227,7 +227,7 @@ private void updateSnapshotMetadata( RepositoryMetadata metadata,
ArtifactRepository selected, ArtifactRepository localRepository )
throws RepositoryMetadataStoreException
{
// TODO: this could be a lot nicer... should really be in the snapshot transformation?
// TODO this could be a lot nicer... should really be in the snapshot transformation?
if ( metadata.isSnapshot() )
{
Metadata prevMetadata = metadata.getMetadata();
@ -312,7 +312,7 @@ private boolean loadMetadata( RepositoryMetadata repoMetadata, ArtifactRepositor
}
/**
* @todo share with DefaultPluginMappingManager.
* TODO share with DefaultPluginMappingManager.
*/
protected Metadata readMetadata( File mappingFile )
throws RepositoryMetadataReadException

2
maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/SnapshotArtifactRepositoryMetadata.java
View File

@ -26,7 +26,7 @@
* Metadata for the artifact version directory of the repository.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @todo split instantiation (versioning, plugin mappings) from definition
* TODO split instantiation (versioning, plugin mappings) from definition
*/
public class SnapshotArtifactRepositoryMetadata
extends AbstractRepositoryMetadata

2
maven-compat/src/main/java/org/apache/maven/artifact/resolver/DebugResolutionListener.java
View File

@ -85,7 +85,7 @@ public void updateScopeCurrentPom( Artifact artifact, String ignoredScope )
logger.debug( indent + artifact + " (not setting artifactScope to: " + ignoredScope + "; local artifactScope "
+ artifact.getScope() + " wins)" );
// TODO: better way than static? this might hide messages in a reactor
// TODO better way than static? this might hide messages in a reactor
if ( !ignoredArtifacts.contains( artifact ) )
{
logger.warn( "\n\tArtifact " + artifact + " retains local artifactScope '" + artifact.getScope()

2
maven-compat/src/main/java/org/apache/maven/artifact/resolver/DefaultArtifactResolver.java
View File

@ -376,7 +376,7 @@ public ArtifactResolutionResult resolve( ArtifactResolutionRequest request )
ArtifactFilter resolutionFilter = request.getResolutionFilter();
RepositorySystemSession session = getSession( request.getLocalRepository() );
// TODO: hack because metadata isn't generated in m2e correctly and i want to run the maven i have in the
// TODO hack because metadata isn't generated in m2e correctly and i want to run the maven i have in the
// workspace
if ( source == null )
{

2
maven-compat/src/main/java/org/apache/maven/project/MavenProjectBuilder.java
View File

@ -54,7 +54,7 @@ MavenProject buildFromRepository( Artifact artifact, List<ArtifactRepository> re
ArtifactRepository localRepository, boolean allowStubModel )
throws ProjectBuildingException;
// TODO: this is only to provide a project for plugins that don't need a project to execute but need some
// TODO this is only to provide a project for plugins that don't need a project to execute but need some
// of the values from a MavenProject. Ideally this should be something internal and nothing outside Maven
// would ever need this so it should not be exposed in a public API
MavenProject buildStandaloneSuperProject( ProjectBuilderConfiguration configuration )

10
maven-compat/src/main/java/org/apache/maven/project/inheritance/DefaultModelInheritanceAssembler.java
View File

@ -51,7 +51,7 @@
public class DefaultModelInheritanceAssembler
implements ModelInheritanceAssembler
{
// TODO: Remove this!
// TODO Remove this!
@SuppressWarnings( "unchecked" )
public void assembleBuildInheritance( Build childBuild, Build parentBuild, boolean handleAsInheritance )
{
@ -303,7 +303,7 @@ private void assembleModelInheritance( Model child, Model parent, String childPa
child.setProperties( props );
}
// TODO: Remove this!
// TODO Remove this!
@SuppressWarnings( "unchecked" )
private void assembleDependencyManagementInheritance( Model child, Model parent )
{
@ -523,7 +523,7 @@ else if ( handleAsInheritance && ( parentInherited == null ) )
}
// TODO: Remove this!
// TODO Remove this!
@SuppressWarnings( "unchecked" )
private void assembleDependencyInheritance( Model child, Model parent )
{
@ -653,7 +653,7 @@ private static DeploymentRepository copyDistributionRepository( DeploymentReposi
return repository;
}
// TODO: This should eventually be migrated to DefaultPathTranslator.
// TODO This should eventually be migrated to DefaultPathTranslator.
protected String appendPath( String parentPath, String childPath, String pathAdjustment, boolean appendPaths )
{
String uncleanPath = parentPath;
@ -689,7 +689,7 @@ protected String appendPath( String parentPath, String childPath, String pathAdj
return cleanedPath + resolvePath( uncleanPath );
}
// TODO: Move this to plexus-utils' PathTool.
// TODO Move this to plexus-utils' PathTool.
private static String resolvePath( String uncleanPath )
{
LinkedList<String> pathElements = new LinkedList<>();

6
maven-compat/src/main/java/org/apache/maven/project/interpolation/AbstractStringBasedModelInterpolator.java
View File

@ -58,7 +58,7 @@
* Use a regular expression search to find and resolve expressions within the POM.
*
* @author jdcasey Created on Feb 3, 2005
* @todo Consolidate this logic with the PluginParameterExpressionEvaluator, minus deprecations/bans.
* TODO Consolidate this logic with the PluginParameterExpressionEvaluator, minus deprecations/bans.
*/
@Deprecated
public abstract class AbstractStringBasedModelInterpolator
@ -104,7 +104,7 @@ protected AbstractStringBasedModelInterpolator( PathTranslator pathTranslator )
}
/**
* @todo: Remove the throws clause.
* TODO Remove the throws clause.
* @throws IOException This exception is not thrown any more, and needs to be removed.
*/
protected AbstractStringBasedModelInterpolator()
@ -190,8 +190,6 @@ public Model interpolate( Model model,
* with the value, and continue to find other expressions.</li>
* <li>If the value is null, get it from the model properties.</li>
* <li>
* @param overrideContext
* @param outputDebugMessages
*/
public String interpolate( String src,
Model model,

2
maven-compat/src/main/java/org/apache/maven/project/interpolation/RegexBasedModelInterpolator.java
View File

@ -30,7 +30,7 @@
* Use a regular expression search to find and resolve expressions within the POM.
*
* @author jdcasey Created on Feb 3, 2005
* @todo Consolidate this logic with the PluginParameterExpressionEvaluator, minus deprecations/bans.
* TODO Consolidate this logic with the PluginParameterExpressionEvaluator, minus deprecations/bans.
*/
@Deprecated
public class RegexBasedModelInterpolator

5
maven-compat/src/main/java/org/apache/maven/repository/MetadataGraph.java
View File

@ -57,7 +57,6 @@ public void addNode( MetadataGraphNode node )
* find a node by the GAV (metadata)
*
* @param md
* @return
*/
public MetadataGraphNode findNode( MavenArtifactMetadata md )
{
@ -76,8 +75,6 @@ public MetadataGraphNode findNode( MavenArtifactMetadata md )
/**
* getter
*
* @return
*/
public MetadataGraphNode getEntry()
{
@ -86,8 +83,6 @@ public MetadataGraphNode getEntry()
/**
* getter
*
* @return
*/
public Collection<MetadataGraphNode> getNodes()
{

2
maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionRequest.java
View File

@ -123,7 +123,7 @@ public List<ArtifactRepository> getRemoteRepositories()
}
/**
* @deprecated instead use {@link #setRemoteRepositories()}
* @deprecated instead use {@link #setRemoteRepositories(List)}
*/
@Deprecated
public MetadataResolutionRequest setRemoteRepostories( List<ArtifactRepository> remoteRepostories )

2
maven-compat/src/main/java/org/apache/maven/repository/MetadataResolutionResult.java
View File

@ -161,7 +161,7 @@ public boolean hasVersionRangeViolations()
}
/**
* @TODO this needs to accept a {@link OverConstrainedVersionException} as returned by
* TODO this needs to accept a {@link OverConstrainedVersionException} as returned by
* {@link #getVersionRangeViolation(int)} but it's not used like that in
* {@link DefaultLegacyArtifactCollector}
*/

12
maven-compat/src/main/java/org/apache/maven/repository/legacy/DefaultWagonManager.java
View File

@ -56,9 +56,9 @@
import org.eclipse.aether.ConfigurationProperties;
import org.eclipse.aether.util.ConfigUtils;
//TODO: remove the update check manager
//TODO: separate into retriever and publisher
//TODO: remove hardcoding of checksum logic
//TODO remove the update check manager
//TODO separate into retriever and publisher
//TODO remove hardcoding of checksum logic
@Component( role = WagonManager.class )
public class DefaultWagonManager
implements WagonManager
@ -378,7 +378,7 @@ public void getRemoteFile( ArtifactRepository repository, File destination, Stri
ChecksumObserver sha1ChecksumObserver = null;
try
{
// TODO: configure on repository
// TODO configure on repository
int i = 0;
md5ChecksumObserver = addChecksumObserver( wagon, CHECKSUM_ALGORITHMS[i++] );
@ -594,7 +594,7 @@ public void putRemoteFile( ArtifactRepository repository, File source, String re
Map<String, String> sums = new HashMap<>( 2 );
// TODO: configure these on the repository
// TODO configure these on the repository
for ( int i = 0; i < CHECKSUM_IDS.length; i++ )
{
checksums.put( CHECKSUM_IDS[i], addChecksumObserver( wagon, CHECKSUM_ALGORITHMS[i] ) );
@ -628,7 +628,7 @@ public void putRemoteFile( ArtifactRepository repository, File source, String re
// We do this in here so we can checksum the artifact metadata too, otherwise it could be metadata itself
for ( String extension : checksums.keySet() )
{
// TODO: shouldn't need a file intermediatary - improve wagon to take a stream
// TODO shouldn't need a file intermediatary - improve wagon to take a stream
File temp = File.createTempFile( "maven-artifact", null );
temp.deleteOnExit();
FileUtils.fileWrite( temp.getAbsolutePath(), "UTF-8", sums.get( extension ) );

2
maven-compat/src/main/java/org/apache/maven/repository/legacy/repository/DefaultArtifactRepositoryFactory.java
View File

@ -37,7 +37,7 @@
public class DefaultArtifactRepositoryFactory
implements ArtifactRepositoryFactory
{
// TODO: use settings?
// TODO use settings?
private String globalUpdatePolicy;
private String globalChecksumPolicy;

14
maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/DefaultLegacyArtifactCollector.java
View File

@ -249,7 +249,7 @@ private void recurse( ArtifactResolutionResult result, ResolutionNode node,
Object key = node.getKey();
// TODO: Does this check need to happen here? Had to add the same call
// TODO Does this check need to happen here? Had to add the same call
// below when we iterate on child nodes -- will that suffice?
if ( managedVersions.containsKey( key ) )
{
@ -272,11 +272,11 @@ private void recurse( ArtifactResolutionResult result, ResolutionNode node,
if ( ( previousRange != null ) && ( currentRange != null ) )
{
// TODO: shouldn't need to double up on this work, only done for simplicity of handling
// TODO shouldn't need to double up on this work, only done for simplicity of handling
// recommended
// version but the restriction is identical
VersionRange newRange = previousRange.restrict( currentRange );
// TODO: ick. this forces the OCE that should have come from the previous call. It is still
// TODO ick. this forces the OCE that should have come from the previous call. It is still
// correct
if ( newRange.isSelectedVersionKnown( previous.getArtifact() ) )
{
@ -363,7 +363,7 @@ private void recurse( ArtifactResolutionResult result, ResolutionNode node,
if ( resolved == null )
{
// TODO: add better exception that can detail the two conflicting artifacts
// TODO add better exception that can detail the two conflicting artifacts
ArtifactResolutionException are =
new ArtifactResolutionException( "Cannot resolve artifact version conflict between "
+ previous.getArtifact().getVersion() + " and "
@ -375,14 +375,14 @@ private void recurse( ArtifactResolutionResult result, ResolutionNode node,
if ( ( resolved != previous ) && ( resolved != node ) )
{
// TODO: add better exception
// TODO add better exception
result.addVersionRangeViolation( new ArtifactResolutionException(
"Conflict resolver returned unknown resolution node: ",
resolved.getArtifact() ) );
}
// TODO: should this be part of mediation?
// TODO should this be part of mediation?
// previous one is more dominant
ResolutionNode nearest;
ResolutionNode farthest;
@ -501,7 +501,7 @@ private void recurse( ArtifactResolutionResult result, ResolutionNode node,
if ( artifact.getVersion() == null )
{
// set the recommended version
// TODO: maybe its better to just pass the range through to retrieval and use a
// TODO maybe its better to just pass the range through to retrieval and use a
// transformation?
ArtifactVersion version;
if ( !artifact.isSelectedVersionKnown() )

2
maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/DefaultConflictResolverFactory.java
View File

@ -32,7 +32,7 @@
* A conflict resolver factory that obtains instances from a plexus container.
*
* @author <a href="mailto:markhobson@gmail.com">Mark Hobson</a>
* @todo you don't need the container in here with the active maps (jvz).
* TODO you don't need the container in here with the active maps (jvz).
* @since 3.0
*/
@Component( role = ConflictResolverFactory.class )

2
maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/NewestConflictResolver.java
View File

@ -54,7 +54,7 @@ public ResolutionNode resolveConflict( ResolutionNode node1, ResolutionNode node
}
catch ( OverConstrainedVersionException exception )
{
// TODO: log message or throw exception?
// TODO log message or throw exception?
return null;
}

2
maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/conflict/OldestConflictResolver.java
View File

@ -54,7 +54,7 @@ public ResolutionNode resolveConflict( ResolutionNode node1, ResolutionNode node
}
catch ( OverConstrainedVersionException exception )
{
// TODO: log message or throw exception?
// TODO log message or throw exception?
return null;
}

6
maven-compat/src/main/java/org/apache/maven/repository/legacy/resolver/transform/AbstractVersionTransformation.java
View File

@ -42,7 +42,7 @@
* Describes a version transformation during artifact resolution.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @todo try and refactor to remove abstract methods - not particular happy about current design
* TODO try and refactor to remove abstract methods - not particular happy about current design
*/
public abstract class AbstractVersionTransformation
extends AbstractLogEnabled
@ -105,8 +105,8 @@ protected String resolveVersion( Artifact artifact, RepositoryRequest request )
version = artifact.getBaseVersion();
}
// TODO: also do this logging for other metadata?
// TODO: figure out way to avoid duplicated message
// TODO also do this logging for other metadata?
// TODO figure out way to avoid duplicated message
if ( getLogger().isDebugEnabled() )
{
if ( !version.equals( artifact.getBaseVersion() ) )

4
maven-compat/src/test/java/org/apache/maven/repository/legacy/resolver/DefaultArtifactCollectorTest.java
View File

@ -166,7 +166,7 @@ public void testResolveCorrectDependenciesWhenDifferentDependenciesOnNearest()
public void disabledtestResolveCorrectDependenciesWhenDifferentDependenciesOnNewest()
throws ArtifactResolutionException, InvalidVersionSpecificationException
{
// TODO: use newest conflict resolver
// TODO use newest conflict resolver
ArtifactSpec a = createArtifactSpec( "a", "1.0" );
ArtifactSpec b = a.addDependency( "b", "1.0" );
ArtifactSpec c2 = b.addDependency( "c", "2.0" );
@ -185,7 +185,7 @@ public void disabledtestResolveCorrectDependenciesWhenDifferentDependenciesOnNew
public void disabledtestResolveCorrectDependenciesWhenDifferentDependenciesOnNewestVersionReplaced()
throws ArtifactResolutionException, InvalidVersionSpecificationException
{
// TODO: use newest conflict resolver
// TODO use newest conflict resolver
ArtifactSpec a = createArtifactSpec( "a", "1.0" );
ArtifactSpec b1 = a.addDependency( "b", "1.0" );
ArtifactSpec c = a.addDependency( "c", "1.0" );

2
maven-core/src/main/java/org/apache/maven/AbstractMavenLifecycleParticipant.java
View File

@ -53,7 +53,7 @@ public void afterProjectsRead( MavenSession session )
* activate profiles and perform similar tasks that affect MavenProject
* instance construction.
*/
// TODO: This is too early for build extensions, so maybe just remove it?
// TODO This is too early for build extensions, so maybe just remove it?
public void afterSessionStart( MavenSession session )
throws MavenExecutionException
{

2
maven-core/src/main/java/org/apache/maven/DefaultArtifactFilterManager.java
View File

@ -85,7 +85,7 @@ public ArtifactFilter getArtifactFilter()
/**
* Returns the artifact filter for the standard core artifacts.
*
* @see org.apache.maven.ArtifactFilterManager#getExtensionDependencyFilter()
* @see org.apache.maven.ArtifactFilterManager#getCoreArtifactFilter()
*/
public ArtifactFilter getCoreArtifactFilter()
{

2
maven-core/src/main/java/org/apache/maven/artifact/DependencyResolutionRequiredException.java
View File

@ -23,7 +23,7 @@
* Exception that occurs when an artifact file is used, but has not been resolved.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @todo it may be better for artifact.getFile() to throw it - perhaps it is a runtime exception?
* TODO it may be better for artifact.getFile() to throw it - perhaps it is a runtime exception?
*/
public class DependencyResolutionRequiredException
extends Exception

4
maven-core/src/main/java/org/apache/maven/artifact/repository/MavenArtifactRepository.java
View File

@ -28,7 +28,7 @@
import org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout;
import org.apache.maven.repository.Proxy;
//TODO: completely separate local and remote artifact repositories
//TODO completely separate local and remote artifact repositories
public class MavenArtifactRepository
implements ArtifactRepository
{
@ -234,7 +234,7 @@ private static String protocol( final String url )
*
* @param url the repository URL
* @return the basedir of the repository
* @todo need to URL decode for spaces?
* TODO need to URL decode for spaces?
*/
private String basedir( String url )
{

4
maven-core/src/main/java/org/apache/maven/artifact/repository/metadata/AbstractRepositoryMetadata.java
View File

@ -181,7 +181,7 @@ public Metadata getMetadata()
public void merge( org.apache.maven.repository.legacy.metadata.ArtifactMetadata metadata )
{
// TODO: not sure that it should assume this, maybe the calls to addMetadata should pre-merge, then artifact
// TODO not sure that it should assume this, maybe the calls to addMetadata should pre-merge, then artifact
// replaces?
AbstractRepositoryMetadata repoMetadata = (AbstractRepositoryMetadata) metadata;
this.metadata.merge( repoMetadata.getMetadata() );
@ -189,7 +189,7 @@ public void merge( org.apache.maven.repository.legacy.metadata.ArtifactMetadata
public void merge( ArtifactMetadata metadata )
{
// TODO: not sure that it should assume this, maybe the calls to addMetadata should pre-merge, then artifact
// TODO not sure that it should assume this, maybe the calls to addMetadata should pre-merge, then artifact
// replaces?
AbstractRepositoryMetadata repoMetadata = (AbstractRepositoryMetadata) metadata;
this.metadata.merge( repoMetadata.getMetadata() );

2
maven-core/src/main/java/org/apache/maven/artifact/repository/metadata/RepositoryMetadata.java
View File

@ -26,7 +26,7 @@
* Describes repository directory metadata.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @todo not happy about the store method - they use "this"
* TODO not happy about the store method - they use "this"
*/
public interface RepositoryMetadata
extends org.apache.maven.artifact.metadata.ArtifactMetadata

4
maven-core/src/main/java/org/apache/maven/artifact/resolver/ArtifactResolutionResult.java
View File

@ -36,7 +36,7 @@
* - network/transfer errors - file system errors: permissions
*
* @author Jason van Zyl
* @TODO carlos: all these possible has*Exceptions and get*Exceptions methods make the clients too
* TODO carlos: all these possible has*Exceptions and get*Exceptions methods make the clients too
* complex requiring a long list of checks, need to create a parent/interface/encapsulation
* for the types of exceptions
*/
@ -173,7 +173,7 @@ public boolean hasVersionRangeViolations()
}
/**
* @TODO this needs to accept a {@link OverConstrainedVersionException} as returned by
* TODO this needs to accept a {@link OverConstrainedVersionException} as returned by
* {@link #getVersionRangeViolation(int)} but it's not used like that in
* {@link DefaultLegacyArtifactCollector}
*/

2
maven-core/src/main/java/org/apache/maven/artifact/resolver/ResolutionNode.java
View File

@ -198,7 +198,7 @@ public void enable()
{
active = true;
// TODO: if it was null, we really need to go find them now... or is this taken care of by the ordering?
// TODO if it was null, we really need to go find them now... or is this taken care of by the ordering?
if ( children != null )
{
for ( ResolutionNode node : children )

2
maven-core/src/main/java/org/apache/maven/artifact/resolver/filter/ExcludesArtifactFilter.java
View File

@ -27,7 +27,7 @@
* Filter to exclude from a list of artifact patterns.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @todo I think this is equiv. to exclusion set filter in maven-core
* TODO I think this is equiv. to exclusion set filter in maven-core
*/
public class ExcludesArtifactFilter
extends IncludesArtifactFilter

2
maven-core/src/main/java/org/apache/maven/artifact/resolver/filter/IncludesArtifactFilter.java
View File

@ -49,7 +49,7 @@ public boolean include( Artifact artifact )
boolean matched = false;
for ( Iterator<String> i = patterns.iterator(); i.hasNext() & !matched; )
{
// TODO: what about wildcards? Just specifying groups? versions?
// TODO what about wildcards? Just specifying groups? versions?
if ( id.equals( i.next() ) )
{
matched = true;

2
maven-core/src/main/java/org/apache/maven/execution/DefaultMavenExecutionRequest.java
View File

@ -1088,7 +1088,7 @@ public List<ArtifactRepository> getPluginArtifactRepositories()
return pluginArtifactRepositories;
}
// TODO: this does not belong here.
// TODO this does not belong here.
@Override
public ProjectBuildingRequest getProjectBuildingRequest()
{

26
maven-core/src/main/java/org/apache/maven/execution/MavenExecutionRequest.java
View File

@ -356,15 +356,15 @@ public interface MavenExecutionRequest
MavenExecutionRequest setUserToolchainsFile( File userToolchainsFile );
/**
*
*
*
*
* @return the global toolchains file
* @since 3.3.0
*/
File getGlobalToolchainsFile();
/**
*
*
* @param globalToolchainsFile the global toolchains file
* @return this request
* @since 3.3.0
@ -388,29 +388,31 @@ public interface MavenExecutionRequest
MavenExecutionRequest setUseLegacyLocalRepository( boolean useLegacyLocalRepository );
/**
* Controls the {@link Builder} used by Maven by specification of the builder's id.
* Controls the {@link org.apache.maven.lifecycle.internal.builder.Builder} used by Maven by specification
* of the builder's id.
*
* @since 3.2.0
*/
MavenExecutionRequest setBuilderId( String builderId );
/**
* Controls the {@link Builder} used by Maven by specification of the builders id.
* Controls the {@link org.apache.maven.lifecycle.internal.builder.Builder} used by Maven by specification
* of the builders id.
*
* @since 3.2.0
*/
String getBuilderId();
/**
*
* @param toolchains all toolchains grouped by type
* @return this request
*
* @param toolchains all toolchains grouped by type
* @return this request
* @since 3.3.0
*/
MavenExecutionRequest setToolchains( Map<String, List<ToolchainModel>> toolchains );
/**
*
*
* @return all toolchains grouped by type, never {@code null}
* @since 3.3.0
*/
@ -428,9 +430,9 @@ public interface MavenExecutionRequest
/**
* @since 3.3.0
*/
*/
MavenExecutionRequest setEventSpyDispatcher( EventSpyDispatcher eventSpyDispatcher );
/**
* @since 3.3.0
*/

5
maven-core/src/main/java/org/apache/maven/execution/scope/WeakMojoExecutionListener.java
View File

@ -25,8 +25,9 @@
/**
* Extension point that allows build extensions observe and possibly veto mojo executions.
* <p>
* Unlike {@link MojoExecutionListener}, this extension point does not trigger instantiation of the component, hence
* "weak" class name prefix. Only applies to mojo execution scoped components.
* Unlike {@link org.apache.maven.execution.MojoExecutionListener}, this extension point does not
* trigger instantiation of the component, hence "weak" class name prefix. Only applies to mojo execution
* scoped components.
*
* @see org.apache.maven.execution.MojoExecutionListener
* @since 3.1.2

4
maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycleExecutor.java
View File

@ -97,8 +97,8 @@ public void execute( MavenSession session )
// fully populated Plugin objects, including executions with goals and default configuration taken
// from the plugin.xml inside a plugin.
//
// TODO: This whole method could probably removed by injecting lifeCyclePluginAnalyzer straight into client site.
// TODO: But for some reason the whole plexus appcontext refuses to start when I try this.
// TODO This whole method could probably removed by injecting lifeCyclePluginAnalyzer straight into client site.
// TODO But for some reason the whole plexus appcontext refuses to start when I try this.
public Set<Plugin> getPluginsBoundByDefaultToAllLifecycles( String packaging )
{

2
maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycles.java
View File

@ -40,7 +40,7 @@
* @author Jason van Zyl
* @author Kristian Rosenvold
*/
// TODO: The configuration for the lifecycle needs to be externalized so that I can use the annotations properly for the
// TODO The configuration for the lifecycle needs to be externalized so that I can use the annotations properly for the
// wiring and reference and external source for the lifecycle configuration.
@Component( role = DefaultLifecycles.class )
public class DefaultLifecycles

12
maven-core/src/main/java/org/apache/maven/lifecycle/MavenExecutionPlan.java
View File

@ -34,13 +34,13 @@
import org.apache.maven.plugin.MojoExecution;
import org.apache.maven.plugin.descriptor.MojoDescriptor;
//TODO: lifecycles being executed
//TODO: what runs in each phase
//TODO: plugins that need downloading
//TODO: project dependencies that need downloading
//TODO: unfortunately the plugins need to be downloaded in order to get the plugin.xml file. need to externalize this
//TODO lifecycles being executed
//TODO what runs in each phase
//TODO plugins that need downloading
//TODO project dependencies that need downloading
//TODO unfortunately the plugins need to be downloaded in order to get the plugin.xml file. need to externalize this
// from the plugin archive.
//TODO: this will be the class that people get in IDEs to modify
//TODO this will be the class that people get in IDEs to modify
public class MavenExecutionPlan
implements Iterable<ExecutionPlanItem>

4
maven-core/src/main/java/org/apache/maven/lifecycle/internal/DefaultLifecycleExecutionPlanCalculator.java
View File

@ -525,8 +525,8 @@ private void injectLifecycleOverlay( Map<String, List<MojoExecution>> lifecycleM
}
// org.apache.maven.plugins:maven-remote-resources-plugin:1.0:process
// TODO: take repo mans into account as one may be aggregating prefixes of many
// TODO: collect at the root of the repository, read the one at the root, and fetch remote if something is missing
// TODO take repo mans into account as one may be aggregating prefixes of many
// TODO collect at the root of the repository, read the one at the root, and fetch remote if something is missing
// or the user forces the issue
private List<MojoExecution> calculateForkedGoal( MojoExecution mojoExecution, MavenSession session,

2
maven-core/src/main/java/org/apache/maven/lifecycle/internal/DependencyContext.java
View File

@ -35,7 +35,7 @@
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/
// TODO: From a concurrency perspective, this class is not good. The combination of mutable/immutable state is not nice
// TODO From a concurrency perspective, this class is not good. The combination of mutable/immutable state is not nice
public class DependencyContext
{

2
maven-core/src/main/java/org/apache/maven/lifecycle/internal/GoalTask.java
View File

@ -22,7 +22,7 @@
/**
* A task that is a goal
* <p/>
* TODO: From a concurrency perspective, this class is not good. The combination of mutable/immutable state is not nice
* TODO From a concurrency perspective, this class is not good. The combination of mutable/immutable state is not nice
*
* @since 3.0
* @author Benjamin Bentmann

4
maven-core/src/main/java/org/apache/maven/lifecycle/internal/MojoDescriptorCreator.java
View File

@ -239,8 +239,8 @@ else if ( numTokens <= 2 )
session.getRepositorySession() );
}
// TODO: take repo mans into account as one may be aggregating prefixes of many
// TODO: collect at the root of the repository, read the one at the root, and fetch remote if something is missing
// TODO take repo mans into account as one may be aggregating prefixes of many
// TODO collect at the root of the repository, read the one at the root, and fetch remote if something is missing
// or the user forces the issue
public Plugin findPluginForPrefix( String prefix, MavenSession session )

2
maven-core/src/main/java/org/apache/maven/lifecycle/internal/ProjectBuildList.java
View File

@ -51,7 +51,7 @@ public ProjectBuildList( List<ProjectSegment> items )
this.items = Collections.unmodifiableList( items );
}
// TODO: Optimize; or maybe just rewrite the whole way aggregating mojos are being run.
// TODO Optimize; or maybe just rewrite the whole way aggregating mojos are being run.
/**
* Returns aProjectBuildList that contains only items for the specified taskSegment
* @param taskSegment the requested tasksegment

2
maven-core/src/main/java/org/apache/maven/lifecycle/internal/ProjectIndex.java
View File

@ -35,7 +35,7 @@
* <p/>
* NOTE: This class is not part of any public api and can be changed or deleted without prior notice.
*/
// Todo: Kristian wonders if this class really is necessary and if it overlaps other concepts.
// TODO Kristian wonders if this class really is necessary and if it overlaps other concepts.
public final class ProjectIndex
{

2
maven-core/src/main/java/org/apache/maven/lifecycle/internal/TaskSegment.java
View File

@ -69,5 +69,5 @@ public boolean isAggregating()
return aggregating;
}
// TODO: Consider throwing UnsupportedSomething on hashCode/equals
// TODO Consider throwing UnsupportedSomething on hashCode/equals
}

2
maven-core/src/main/java/org/apache/maven/lifecycle/internal/builder/BuilderCommon.java
View File

@ -188,7 +188,7 @@ public static void attachToThread( MavenProject currentProject )
}
}
// Todo: I'm really wondering where this method belongs; smells like it should be on MavenProject, but for some
// TODO I'm really wondering where this method belongs; smells like it should be on MavenProject, but for some
// reason it isn't ? This localization is kind-of a code smell.
public static String getKey( MavenProject project )

8
maven-core/src/main/java/org/apache/maven/lifecycle/mapping/Lifecycle.java
View File

@ -62,7 +62,7 @@ public Map<String, LifecyclePhase> getLifecyclePhases()
{
return this.lifecyclePhases;
}
/**
* Method setId
*
@ -76,7 +76,7 @@ public void setId( String id )
/**
* Method setLifecyclePhases
*
* @param phases
* @param lifecyclePhases
*/
public void setLifecyclePhases( Map<String, LifecyclePhase> lifecyclePhases )
{
@ -91,12 +91,12 @@ public Map<String, String> getPhases()
{
return null;
}
if ( lphases.isEmpty() )
{
return Collections.emptyMap();
}
Map<String, String> phases = new LinkedHashMap<>();
for ( Map.Entry<String, LifecyclePhase> e: lphases.entrySet() )
{

4
maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManager.java
View File

@ -37,8 +37,8 @@
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.repository.RemoteRepository;
// TODO: the antrun plugin has its own configurator, the only plugin that does. might need to think about how that works
// TODO: remove the coreArtifactFilterManager
// TODO the antrun plugin has its own configurator, the only plugin that does. might need to think about how that works
// TODO remove the coreArtifactFilterManager
@Component( role = BuildPluginManager.class )
public class DefaultBuildPluginManager

14
maven-core/src/main/java/org/apache/maven/plugin/PluginParameterExpressionEvaluator.java
View File

@ -83,7 +83,7 @@ public class PluginParameterExpressionEvaluator
private Properties properties;
@Deprecated //TODO: used by the Enforcer plugin
@Deprecated //TODO used by the Enforcer plugin
public PluginParameterExpressionEvaluator( MavenSession session, MojoExecution mojoExecution,
PathTranslator pathTranslator, Logger logger, MavenProject project,
Properties properties )
@ -228,7 +228,7 @@ else if ( expression.startsWith( "session" ) )
}
catch ( Exception e )
{
// TODO: don't catch exception
// TODO don't catch exception
throw new ExpressionEvaluationException( "Error evaluating plugin parameter expression: " + expression,
e );
}
@ -268,7 +268,7 @@ else if ( expression.startsWith( "project" ) || expression.startsWith( "pom" ) )
}
catch ( Exception e )
{
// TODO: don't catch exception
// TODO don't catch exception
throw new ExpressionEvaluationException( "Error evaluating plugin parameter expression: " + expression,
e );
}
@ -300,7 +300,7 @@ else if ( expression.startsWith( "mojo" ) )
}
catch ( Exception e )
{
// TODO: don't catch exception
// TODO don't catch exception
throw new ExpressionEvaluationException( "Error evaluating plugin parameter expression: " + expression,
e );
}
@ -357,7 +357,7 @@ else if ( expression.startsWith( "settings" ) )
}
catch ( Exception e )
{
// TODO: don't catch exception
// TODO don't catch exception
throw new ExpressionEvaluationException( "Error evaluating plugin parameter expression: " + expression,
e );
}
@ -412,7 +412,7 @@ else if ( expression.startsWith( "basedir" ) )
if ( value instanceof String )
{
// TODO: without #, this could just be an evaluate call...
// TODO without #, this could just be an evaluate call...
String val = (String) value;
@ -457,7 +457,7 @@ private String stripTokens( String expr )
@Override
public File alignToBaseDirectory( File file )
{
// TODO: Copied from the DefaultInterpolator. We likely want to resurrect the PathTranslator or at least a
// TODO Copied from the DefaultInterpolator. We likely want to resurrect the PathTranslator or at least a
// similar component for re-usage
if ( file != null )
{

4
maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultMavenPluginManager.java
View File

@ -124,7 +124,7 @@ public class DefaultMavenPluginManager
* PluginId=>ExtensionRealmCache.CacheRecord map MavenProject context value key. The map is used to ensure the same
* class realm is used to load build extensions and load mojos for extensions=true plugins.
*
* @noreference this is part of internal implementation and may be changed or removed without notice
* @provisional This is part of internal implementation and may be changed or removed without notice
* @since 3.3.0
*/
public static final String KEY_EXTENSIONS_REALMS = DefaultMavenPluginManager.class.getName() + "/extensionsRealms";
@ -617,7 +617,7 @@ private void populatePluginFields( Object mojo, MojoDescriptor mojoDescriptor, C
try
{
// TODO: could the configuration be passed to lookup and the configurator known to plexus via the descriptor
// TODO could the configuration be passed to lookup and the configurator known to plexus via the descriptor
// so that this method could entirely be handled by a plexus lookup?
configurator = container.lookup( ComponentConfigurator.class, configuratorId );

2
maven-core/src/main/java/org/apache/maven/project/DuplicateArtifactAttachmentException.java
View File

@ -27,7 +27,7 @@
*
* @author pgier
* @author jdcasey
* @todo Make this a checked exception, and modify the API of MavenProjectHelper.
* TODO Make this a checked exception, and modify the API of MavenProjectHelper.
* Currently, this modification would create compatibility problems for existing plugins.
*/
public class DuplicateArtifactAttachmentException

32
maven-core/src/main/java/org/apache/maven/project/MavenProject.java
View File

@ -221,7 +221,7 @@ public void setArtifact( Artifact artifact )
this.artifact = artifact;
}
// @todo I would like to get rid of this. jvz.
// TODO I would like to get rid of this. jvz.
public Model getModel()
{
return model;
@ -352,7 +352,7 @@ public List<String> getCompileClasspathElements()
{
if ( a.getArtifactHandler().isAddedToClasspath() )
{
// TODO: let the scope handler deal with this
// TODO let the scope handler deal with this
if ( Artifact.SCOPE_COMPILE.equals( a.getScope() ) || Artifact.SCOPE_PROVIDED.equals( a.getScope() )
|| Artifact.SCOPE_SYSTEM.equals( a.getScope() ) )
{
@ -364,7 +364,7 @@ public List<String> getCompileClasspathElements()
return list;
}
// TODO: this checking for file == null happens because the resolver has been confused about the root
// TODO this checking for file == null happens because the resolver has been confused about the root
// artifact or not. things like the stupid dummy artifact coming from surefire.
public List<String> getTestClasspathElements()
throws DependencyResolutionRequiredException
@ -408,7 +408,7 @@ public List<String> getRuntimeClasspathElements()
for ( Artifact a : getArtifacts() )
{
if ( a.getArtifactHandler().isAddedToClasspath()
// TODO: let the scope handler deal with this
// TODO let the scope handler deal with this
&& ( Artifact.SCOPE_COMPILE.equals( a.getScope() ) || Artifact.SCOPE_RUNTIME.equals( a.getScope() ) ) )
{
addArtifactPath( a, list );
@ -470,7 +470,7 @@ public void setName( String name )
public String getName()
{
// TODO: this should not be allowed to be null.
// TODO this should not be allowed to be null.
if ( getModel().getName() != null )
{
return getModel().getName();
@ -1575,10 +1575,10 @@ public List<Artifact> getCompileArtifacts()
for ( Artifact a : getArtifacts() )
{
// TODO: classpath check doesn't belong here - that's the other method
// TODO classpath check doesn't belong here - that's the other method
if ( a.getArtifactHandler().isAddedToClasspath() )
{
// TODO: let the scope handler deal with this
// TODO let the scope handler deal with this
if ( Artifact.SCOPE_COMPILE.equals( a.getScope() ) || Artifact.SCOPE_PROVIDED.equals( a.getScope() )
|| Artifact.SCOPE_SYSTEM.equals( a.getScope() ) )
{
@ -1603,7 +1603,7 @@ public List<Dependency> getCompileDependencies()
for ( Artifact a : getArtifacts() )
{
// TODO: let the scope handler deal with this
// TODO let the scope handler deal with this
if ( Artifact.SCOPE_COMPILE.equals( a.getScope() ) || Artifact.SCOPE_PROVIDED.equals( a.getScope() )
|| Artifact.SCOPE_SYSTEM.equals( a.getScope() ) )
{
@ -1629,7 +1629,7 @@ public List<Artifact> getTestArtifacts()
for ( Artifact a : getArtifacts() )
{
// TODO: classpath check doesn't belong here - that's the other method
// TODO classpath check doesn't belong here - that's the other method
if ( a.getArtifactHandler().isAddedToClasspath() )
{
list.add( a );
@ -1680,7 +1680,7 @@ public List<Dependency> getRuntimeDependencies()
for ( Artifact a : getArtifacts() )
{
// TODO: let the scope handler deal with this
// TODO let the scope handler deal with this
if ( Artifact.SCOPE_COMPILE.equals( a.getScope() ) || Artifact.SCOPE_RUNTIME.equals( a.getScope() ) )
{
Dependency dependency = new Dependency();
@ -1705,9 +1705,9 @@ public List<Artifact> getRuntimeArtifacts()
for ( Artifact a : getArtifacts() )
{
// TODO: classpath check doesn't belong here - that's the other method
// TODO classpath check doesn't belong here - that's the other method
if ( a.getArtifactHandler().isAddedToClasspath()
// TODO: let the scope handler deal with this
// TODO let the scope handler deal with this
&& ( Artifact.SCOPE_COMPILE.equals( a.getScope() ) || Artifact.SCOPE_RUNTIME.equals( a.getScope() ) ) )
{
list.add( a );
@ -1732,7 +1732,7 @@ public List<String> getSystemClasspathElements()
{
if ( a.getArtifactHandler().isAddedToClasspath() )
{
// TODO: let the scope handler deal with this
// TODO let the scope handler deal with this
if ( Artifact.SCOPE_SYSTEM.equals( a.getScope() ) )
{
addArtifactPath( a, list );
@ -1749,10 +1749,10 @@ public List<Artifact> getSystemArtifacts()
for ( Artifact a : getArtifacts() )
{
// TODO: classpath check doesn't belong here - that's the other method
// TODO classpath check doesn't belong here - that's the other method
if ( a.getArtifactHandler().isAddedToClasspath() )
{
// TODO: let the scope handler deal with this
// TODO let the scope handler deal with this
if ( Artifact.SCOPE_SYSTEM.equals( a.getScope() ) )
{
list.add( a );
@ -1776,7 +1776,7 @@ public List<Dependency> getSystemDependencies()
for ( Artifact a : getArtifacts() )
{
// TODO: let the scope handler deal with this
// TODO let the scope handler deal with this
if ( Artifact.SCOPE_SYSTEM.equals( a.getScope() ) )
{
Dependency dependency = new Dependency();

2
maven-core/src/main/java/org/apache/maven/project/ProjectSorter.java
View File

@ -233,7 +233,7 @@ private boolean isSpecificVersion( String version )
return !( StringUtils.isEmpty( version ) || version.startsWith( "[" ) || version.startsWith( "(" ) );
}
// TODO: !![jc; 28-jul-2005] check this; if we're using '-r' and there are aggregator tasks, this will result in weirdness.
// TODO !![jc; 28-jul-2005] check this; if we're using '-r' and there are aggregator tasks, this will result in weirdness.
public MavenProject getTopLevelProject()
{
if ( topLevelProject == null )

2
maven-core/src/main/java/org/apache/maven/project/artifact/ActiveProjectArtifact.java
View File

@ -38,7 +38,7 @@
* attributes of this artifact.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @todo I think this exposes a design flaw in that the immutable and mutable parts of an artifact are in one class and
* TODO I think this exposes a design flaw in that the immutable and mutable parts of an artifact are in one class and
* should be split. ie scope, file, etc depend on the context of use, whereas everything else is immutable.
*/
@Deprecated

6
maven-core/src/main/java/org/apache/maven/project/artifact/MavenMetadataSource.java
View File

@ -93,7 +93,7 @@ public class MavenMetadataSource
@Requirement
private ArtifactFactory repositorySystem;
//TODO: This prevents a cycle in the composition which shows us another problem we need to deal with.
//TODO This prevents a cycle in the composition which shows us another problem we need to deal with.
//@Requirement
private ProjectBuilder projectBuilder;
@ -175,7 +175,7 @@ public ResolutionGroup retrieve( MetadataResolutionRequest request )
Artifact relocatedArtifact = null;
//TODO: Not even sure this is really required as the project will be cached in the builder, we'll see this
//TODO Not even sure this is really required as the project will be cached in the builder, we'll see this
// is currently the biggest hotspot
if ( artifact instanceof ArtifactWithDependencies )
{
@ -658,7 +658,7 @@ else if ( isNonTransferrablePom( e ) )
// MNG-2861: the artifact data has changed. If the available versions where previously
// retrieved, we need to update it.
// TODO: shouldn't the versions be merged across relocations?
// TODO shouldn't the versions be merged across relocations?
List<ArtifactVersion> available = artifact.getAvailableVersions();
if ( available != null && !available.isEmpty() )
{

6
maven-core/src/main/java/org/apache/maven/properties/internal/SystemProperties.java
View File

@ -28,8 +28,6 @@ public class SystemProperties
{
/**
* Thread-safe System.properties copy implementation.
*
* @see https://issues.apache.org/jira/browse/MNG-5670
*/
public static void addSystemProperties( Properties props )
{
@ -38,8 +36,8 @@ public static void addSystemProperties( Properties props )
/**
* Returns a copy of {@link System#getProperties()} in a thread-safe manner.
*
* @return {@link System#getProperties()} obtained in a thread-safe manner.
*
* @return {@link System#getProperties()} obtained in a thread-safe manner.
*/
public static Properties getSystemProperties()
{

2
maven-core/src/main/java/org/apache/maven/settings/DefaultMavenSettingsBuilder.java
View File

@ -127,7 +127,7 @@ private File getFile( String pathPattern, String basedirSysProp, String altLocat
if ( StringUtils.isEmpty( path ) )
{
// TODO: This replacing shouldn't be necessary as user.home should be in the
// TODO This replacing shouldn't be necessary as user.home should be in the
// context of the container and thus the value would be interpolated by Plexus
String basedir = System.getProperty( basedirSysProp );
if ( basedir == null )

2
maven-core/src/main/java/org/apache/maven/toolchain/DefaultToolchainManager.java
View File

@ -124,7 +124,7 @@ Map<String, Object> retrieveContext( MavenSession session )
if ( current != null )
{
//TODO: why is this using the context
//TODO why is this using the context
context = session.getPluginContext( desc, current );
}
}

6
maven-core/src/main/java/org/apache/maven/toolchain/ToolchainManager.java
View File

@ -44,16 +44,16 @@ public interface ToolchainManager
* <code>maven-toolchains-plugin</code> contains the configuration to select the appropriate
* toolchain and is executed at the beginning of the build.
*
* @param session the Maven session, must not be {@code null}
* @param type the type, must not be {@code null}
* @param context the Maven session, must not be {@code null}
* @return the toolchain selected by <code>maven-toolchains-plugin</code>
*/
Toolchain getToolchainFromBuildContext( String type, MavenSession context );
/**
* Select all toolchains available in user settings matching the type and requirements,
* independently from <code>maven-toolchains-plugin</code>.
*
*
* @param session the Maven session, must not be {@code null}
* @param type the type, must not be {@code null}
* @param requirements the requirements, may be {@code null}

2
maven-core/src/test/java/org/apache/maven/lifecycle/internal/ProjectBuildListTest.java
View File

@ -36,7 +36,7 @@ public void testGetByTaskSegment()
final ProjectBuildList byTaskSegment = projectBuildList.getByTaskSegment( taskSegment );
assertEquals( projectBuildList.size(),
byTaskSegment.size() ); // Todo: Make multiple segments on projectBuildList
byTaskSegment.size() ); // TODO Make multiple segments on projectBuildList
}
}

6
maven-core/src/test/java/org/apache/maven/plugin/PluginManagerTest.java
View File

@ -103,7 +103,7 @@ public void testMojoDescriptorRetrieval()
// Tests which exercise the lifecycle executor when it is dealing with individual goals.
// -----------------------------------------------------------------------------------------------
//TODO: These two tests display a lack of symmetry with respect to the input which is a free form string and the
//TODO These two tests display a lack of symmetry with respect to the input which is a free form string and the
// mojo descriptor which comes back. All the free form parsing needs to be done somewhere else, this is
// really the function of the CLI, and then the pre-processing of that output still needs to be fed into
// a hinting process which helps flesh out the full specification of the plugin. The plugin manager should
@ -113,7 +113,7 @@ public void testMojoDescriptorRetrieval()
public void testRemoteResourcesPlugin()
throws Exception
{
//TODO: turn an equivalent back on when the RR plugin is released.
//TODO turn an equivalent back on when the RR plugin is released.
/*
@ -138,7 +138,7 @@ public void testRemoteResourcesPlugin()
*/
}
//TODO: this will be the basis of the customizable lifecycle execution so need to figure this out quickly.
//TODO this will be the basis of the customizable lifecycle execution so need to figure this out quickly.
public void testSurefirePlugin()
throws Exception
{

2
maven-core/src/test/java/org/apache/maven/project/artifact/MavenMetadataSourceTest.java
View File

@ -90,7 +90,7 @@ public void testShouldNotCarryExclusionsOverFromDependencyToDependency()
*/
}
//TODO: restore these if it makes sense
//TODO restore these if it makes sense
/*
public void testShouldUseCompileScopeIfDependencyScopeEmpty()
throws Exception

2
maven-embedder/src/main/java/org/apache/maven/cli/CleanArgument.java
View File

@ -64,7 +64,7 @@ public static String[] cleanArgs( String[] args )
// otherwise, we trim the trailing " and append to the buffer.
else
{
// TODO: introducing a space here...not sure what else to do but collapse whitespace
// TODO introducing a space here...not sure what else to do but collapse whitespace
currentArg.append( ' ' ).append( cleanArgPart );
}

8
maven-embedder/src/main/java/org/apache/maven/cli/MavenCli.java
View File

@ -115,7 +115,7 @@
import java.util.regex.Matcher;
import java.util.regex.Pattern;
// TODO: push all common bits back to plexus cli and prepare for transition to Guice. We don't need 50 ways to make CLIs
// TODO push all common bits back to plexus cli and prepare for transition to Guice. We don't need 50 ways to make CLIs
/**
* @author Jason van Zyl
@ -211,7 +211,7 @@ public static int main( String[] args, ClassWorld classWorld )
return result;
}
// TODO: need to externalize CliRequest
// TODO need to externalize CliRequest
public static int doMain( String[] args, ClassWorld classWorld )
{
MavenCli cli = new MavenCli();
@ -283,7 +283,7 @@ public int doMain( String[] args, String workingDirectory, PrintStream stdout, P
}
}
// TODO: need to externalize CliRequest
// TODO need to externalize CliRequest
public int doMain( CliRequest cliRequest )
{
PlexusContainer localContainer = null;
@ -1510,7 +1510,7 @@ else if ( commandLine.hasOption( CLIManager.ALSO_MAKE ) && commandLine.hasOption
final String threadConfiguration = commandLine.hasOption( CLIManager.THREADS )
? commandLine.getOptionValue( CLIManager.THREADS )
: request.getSystemProperties().getProperty(
MavenCli.THREADS_DEPRECATED ); // TODO: Remove this setting. Note that the int-tests use it
MavenCli.THREADS_DEPRECATED ); // TODO Remove this setting. Note that the int-tests use it
if ( threadConfiguration != null )
{

2
maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java
View File

@ -888,7 +888,7 @@ private ModelData readParentLocally( Model childModel, ModelSource childSource,
}
//
// TODO:jvz Why isn't all this checking the job of the duty of the workspace resolver, we know that we
// TODO jvz Why isn't all this checking the job of the duty of the workspace resolver, we know that we
// have a model that is suitable, yet more checks are done here and the one for the version is problematic
// before because with parents as ranges it will never work in this scenario.
//

4
maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuilder.java
View File

@ -57,10 +57,6 @@ ModelBuildingResult build( ModelBuildingRequest request, ModelBuildingResult res
/**
* Performs only the part of {@link ModelBuilder#build(ModelBuildingRequest)} that loads the raw model
*
* @param request
* @return
* @throws ModelBuildingException
*/
Result<? extends Model> buildRawModel( File pomFile, int validationLevel, boolean locationTracking );

4
maven-model-builder/src/main/java/org/apache/maven/model/building/ModelBuildingRequest.java
View File

@ -66,7 +66,7 @@ public interface ModelBuildingRequest
/**
* Gets the raw model to build. If not set, model source will be used to load raw model.
*
*
* @return The raw model to build or {@code null} if not set.
*/
Model getRawModel();
@ -74,7 +74,7 @@ public interface ModelBuildingRequest
/**
* Set raw model.
*
* @param model
* @param rawModel
*/
ModelBuildingRequest setRawModel( Model rawModel );

23
maven-model-builder/src/main/java/org/apache/maven/model/building/Result.java
View File

@ -46,7 +46,7 @@
* <li>error - (partial) model and diagnostics
* </ol>
* Could encode these variants as subclasses, but kept in one for now
*
*
* @author bbusjaeger
* @param <T>
*/
@ -55,9 +55,8 @@ public class Result<T>
/**
* Success without warnings
*
*
* @param model
* @return
*/
public static <T> Result<T> success( T model )
{
@ -66,10 +65,9 @@ public static <T> Result<T> success( T model )
/**
* Success with warnings
*
*
* @param model
* @param problems
* @return
*/
public static <T> Result<T> success( T model, Iterable<? extends ModelProblem> problems )
{
@ -79,10 +77,9 @@ public static <T> Result<T> success( T model, Iterable<? extends ModelProblem> p
/**
* Success with warnings
*
*
* @param model
* @param results
* @return
*/
public static <T> Result<T> success( T model, Result<?>... results )
{
@ -93,7 +90,6 @@ public static <T> Result<T> success( T model, Result<?>... results )
* Error with problems describing the cause
*
* @param problems
* @return
*/
public static <T> Result<T> error( Iterable<? extends ModelProblem> problems )
{
@ -120,7 +116,6 @@ public static <T> Result<T> error( Result<?>... results )
*
* @param model
* @param problems
* @return
*/
public static <T> Result<T> error( T model, Iterable<? extends ModelProblem> problems )
{
@ -129,10 +124,9 @@ public static <T> Result<T> error( T model, Iterable<? extends ModelProblem> pro
/**
* New result - determine whether error or success by checking problems for errors
*
*
* @param model
* @param problems
* @return
*/
public static <T> Result<T> newResult( T model, Iterable<? extends ModelProblem> problems )
{
@ -142,10 +136,9 @@ public static <T> Result<T> newResult( T model, Iterable<? extends ModelProblem>
/**
* New result consisting of given result and new problem. Convenience for newResult(result.get(),
* concat(result.getProblems(),problems)).
*
*
* @param result
* @param problem
* @return
*/
public static <T> Result<T> addProblem( Result<T> result, ModelProblem problem )
{
@ -157,7 +150,6 @@ public static <T> Result<T> addProblem( Result<T> result, ModelProblem problem )
*
* @param result
* @param problems
* @return
*/
public static <T> Result<T> addProblems( Result<T> result, Iterable<? extends ModelProblem> problems )
{
@ -172,9 +164,8 @@ public static <T> Result<T> addProblems( Result<T> result, Result<?>... results
/**
* Turns the given results into a single result by combining problems and models into single collection.
*
*
* @param results
* @return
*/
public static <T> Result<Iterable<T>> newResultSet( Iterable<? extends Result<? extends T>> results )
{

2
maven-model-builder/src/main/java/org/apache/maven/model/interpolation/StringSearchModelInterpolator.java
View File

@ -306,7 +306,7 @@ void interpolate( Object target, InterpolateObjectAction interpolateObjectAction
new ModelProblemCollectorRequest( Severity.ERROR, Version.BASE ).setMessage(
"Failed to interpolate field3: " + field + " on class: "
+ field.getType().getName() ).setException(
e ) ); // todo: Not entirely the same message
e ) ); // TODO Not entirely the same message
}
catch ( IllegalAccessException e )
{

6
maven-model-builder/src/main/java/org/apache/maven/model/merge/MavenModelMerger.java
View File

@ -109,7 +109,7 @@ else if ( target.getUrl() == null )
}
/*
* TODO: Whether the merge continues recursively into an existing node or not could be an option for the generated
* TODO Whether the merge continues recursively into an existing node or not could be an option for the generated
* merger
*/
@Override
@ -266,7 +266,7 @@ protected void mergeModelBase_Modules( ModelBase target, ModelBase source, boole
}
/*
* TODO: The order of the merged list could be controlled by an attribute in the model association: target-first,
* TODO The order of the merged list could be controlled by an attribute in the model association: target-first,
* source-first, dominant-first, recessive-first
*/
@Override
@ -352,7 +352,7 @@ protected void mergeModelBase_PluginRepositories( ModelBase target, ModelBase so
}
/*
* TODO: Whether duplicates should be removed looks like an option for the generated merger.
* TODO Whether duplicates should be removed looks like an option for the generated merger.
*/
@Override
protected void mergeBuildBase_Filters( BuildBase target, BuildBase source, boolean sourceDominant,

2
maven-model-builder/src/main/java/org/apache/maven/model/validation/DefaultModelValidator.java
View File

@ -532,7 +532,7 @@ private void validateEffectiveDependencies( ModelProblemCollector problems, List
d.getManagementKey(), d );
/*
* TODO: Extensions like Flex Mojos use custom scopes like "merged", "internal", "external", etc. In
* TODO Extensions like Flex Mojos use custom scopes like "merged", "internal", "external", etc. In
* order to don't break backward-compat with those, only warn but don't error out.
*/
validateEnum( prefix + "scope", problems, Severity.WARNING, Version.V20, d.getScope(),

2
maven-plugin-api/src/main/java/org/apache/maven/plugin/Mojo.java
View File

@ -58,7 +58,7 @@ void execute()
*
* @param log a new logger
*/
// TODO: not sure about this here, and may want a getLog on here as well/instead
// TODO not sure about this here, and may want a getLog on here as well/instead
void setLog( Log log );
/**

4
maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/MojoDescriptor.java
View File

@ -36,7 +36,7 @@
* <a href="https://maven.apache.org/developers/mojo-api-specification.html">
* https://maven.apache.org/developers/mojo-api-specification.html</a>
*
* @todo is there a need for the delegation of MavenMojoDescriptor to this?
* TODO is there a need for the delegation of MavenMojoDescriptor to this?
* Why not just extend ComponentDescriptor here?
*/
public class MojoDescriptor
@ -269,7 +269,7 @@ public String getDependencyResolutionRequired()
/**
* @return the required dependencies in a specified scope
* @TODO the name is not intelligible
* TODO the name is not intelligible
*/
@Deprecated
public String isDependencyResolutionRequired()

4
maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java
View File

@ -176,7 +176,7 @@ public static String getDefaultPluginGroupId()
/**
* Parse maven-...-plugin.
*
* @todo move to plugin-tools-api as a default only
* TODO move to plugin-tools-api as a default only
*/
public static String getGoalPrefixFromArtifactId( String artifactId )
{
@ -287,7 +287,7 @@ public MojoDescriptor getMojo( String goal )
return null; // no mojo in this POM
}
// TODO: could we use a map? Maybe if the parent did that for components too, as this is too vulnerable to
// TODO could we use a map? Maybe if the parent did that for components too, as this is too vulnerable to
// changes above not being propagated to the map
for ( MojoDescriptor desc : getMojos() )
{

2
maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptorBuilder.java
View File

@ -313,7 +313,7 @@ public MojoDescriptor buildComponentDescriptor( PlexusConfiguration c, PluginDes
mojo.setParameters( parameters );
// TODO: this should not need to be handed off...
// TODO this should not need to be handed off...
// ----------------------------------------------------------------------
// Requirements

2
maven-plugin-api/src/main/java/org/apache/maven/plugin/logging/SystemStreamLog.java
View File

@ -141,7 +141,7 @@ public void error( Throwable error )
*/
public boolean isDebugEnabled()
{
// TODO: Not sure how best to set these for this implementation...
// TODO Not sure how best to set these for this implementation...
return false;
}

17
pom.xml
View File

@ -640,14 +640,15 @@ under the License.
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<linksource>true</linksource>
<notimestamp>true</notimestamp>
<quiet>true</quiet>
<links combine.children="append">
<!-- TODO link to Maven Resolver Javadoc -->
<link>http://download.eclipse.org/aether/aether-core/${aetherVersion}/apidocs/</link>
<link>https://codehaus-plexus.github.io/plexus-containers/plexus-container-default/apidocs/</link>
</links>
<!-- TODO Remove when we upgrade to maven-parent 31 -->
<locale>en</locale>
<tags>
<tag>
<name>provisional</name>
<placement>tf</placement>
<head>Provisional:</head>
</tag>
</tags>
</configuration>
<reportSets>
<reportSet>