Skip to content

Commit 0794fa6

Browse files
committed
Add some javadoc
1 parent 58027b5 commit 0794fa6

File tree

5 files changed

+25
-3
lines changed

5 files changed

+25
-3
lines changed

compat/maven-resolver-provider/src/main/java/org/apache/maven/repository/internal/type/TypeDeriver.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@
4444
* children need to be remapped to certain processor type as well, to end up on proper path type.
4545
*
4646
* @since 4.0.0
47+
* @deprecated since 4.0.0, this is internal detail of Maven.
4748
*/
49+
@Deprecated(since = "4.0.0")
4850
public class TypeDeriver implements DependencyGraphTransformer {
4951
private final Logger logger = LoggerFactory.getLogger(getClass());
5052

impl/maven-impl/src/main/java/org/apache/maven/impl/resolver/type/DefaultType.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
import static java.util.Objects.requireNonNull;
3737

3838
/**
39-
* Default implementation of {@link Type} and Resolver {@link ArtifactType}.
39+
* Default implementation of {@link Type} and adapter for Resolver {@link ArtifactType}.
4040
*
4141
* @since 4.0.0
4242
*/
@@ -119,6 +119,12 @@ public String toString() {
119119
+ properties + ']';
120120
}
121121

122+
/**
123+
* Adapts this instance to Resolver {@link ArtifactType}.
124+
* <p>
125+
* Note: one notable difference exists, the {@link #getClassifier()} method behavior.
126+
* Once that harmonized, this adapting can go away.
127+
*/
122128
public ArtifactType toArtifactType() {
123129
return new ArtifactTypeAdapter(this);
124130
}

impl/maven-impl/src/main/java/org/apache/maven/impl/resolver/type/DefaultTypeProvider.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727
import org.apache.maven.api.di.Named;
2828
import org.apache.maven.api.spi.TypeProvider;
2929

30+
/**
31+
* Maven 4 default {@link TypeProvider} implementation.
32+
*/
3033
@Named
3134
public class DefaultTypeProvider implements TypeProvider {
3235
@SuppressWarnings({"rawtypes", "unchecked"})

impl/maven-impl/src/main/java/org/apache/maven/impl/resolver/type/TypeDeriver.java

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,16 @@
4040
import static java.util.Objects.requireNonNull;
4141

4242
/**
43-
* Type deriver, that handles special case of "processor" type: if a dependency node is of this type, all of its
44-
* children need to be remapped to certain processor type as well, to end up on proper path type.
43+
* Type deriver, that handles special cases of "processor" (annotation processor) node transitive dependencies: all
44+
* children of "processor" type are "redirected" to corresponding processor subtypes:
45+
* <ul>
46+
* <li>{@code jar -> processor}</li>
47+
* <li>{@code classpathJar -> classpathProcessor}</li>
48+
* <li>{@code modularJar -> modularProcessor}</li>
49+
* </ul>
50+
*
51+
* Maven 4 introduces new types to describe intent of dependencies, and the "processor" new type (and it's subtypes)
52+
* will add processors and their dependencies to proper processor paths, as modern Java versions require.
4553
*
4654
* @since 4.0.0
4755
*/

impl/maven-impl/src/main/java/org/apache/maven/impl/resolver/type/TypeRegistryAdapter.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@
2626

2727
import static java.util.Objects.requireNonNull;
2828

29+
/**
30+
* Adapter between Maven {@link TypeRegistry} and Resolver {@link ArtifactTypeRegistry}.
31+
*/
2932
public class TypeRegistryAdapter implements ArtifactTypeRegistry {
3033
private final TypeRegistry typeRegistry;
3134

0 commit comments

Comments
 (0)