[
https://issues.apache.org/jira/browse/MSHARED-1454?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17911148#comment-17911148
]
ASF GitHub Bot commented on MSHARED-1454:
-----------------------------------------
elharo commented on code in PR #50:
URL:
https://github.com/apache/maven-dependency-tree/pull/50#discussion_r1907400797
##########
src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java:
##########
@@ -32,31 +32,70 @@ public class ConflictData {
private Boolean originaOptionality;
+ /**
+ * Construct ConflictData. Containing information about conflicts during
dependency resolution.
+ * Either this node lost the conflict and winnerVersion is set with the
versionwof the winnig node,
+ * or this node won and winnerVersion is @code{null}.
+ * If this node won ignoredScope can contain potential scopes that were
ignored during conflict resolution.
Review Comment:
won,
##########
src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java:
##########
@@ -32,31 +32,70 @@ public class ConflictData {
private Boolean originaOptionality;
+ /**
+ * Construct ConflictData. Containing information about conflicts during
dependency resolution.
+ * Either this node lost the conflict and winnerVersion is set with the
versionwof the winnig node,
Review Comment:
versions of the winning node,
##########
src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java:
##########
@@ -32,31 +32,70 @@ public class ConflictData {
private Boolean originaOptionality;
+ /**
+ * Construct ConflictData. Containing information about conflicts during
dependency resolution.
+ * Either this node lost the conflict and winnerVersion is set with the
versionwof the winnig node,
+ * or this node won and winnerVersion is @code{null}.
+ * If this node won ignoredScope can contain potential scopes that were
ignored during conflict resolution.
+ *
+ * @param winnerVersion the version of the dependency that was selected.
+ * @param ignoredScope the scope
+ */
public ConflictData(String winnerVersion, String ignoredScope) {
this.winnerVersion = winnerVersion;
this.ignoredScope = ignoredScope;
}
+ /**
+ * In case of a conflict, the version of the dependency that was selected.
+ *
+ * @return the version of the dependency node that was selected.
+ */
public String getWinnerVersion() {
return winnerVersion;
}
+ /**
+ * Original scope of a rejected dependency due to a conflict.
+ *
+ * @return the original scope of the dependency that was updated from.
+ */
public String getOriginalScope() {
return originalScope;
}
+ /**
+ * Set original scope of a rejected dependency due to a conflict.
+ *
+ * @param originalScope the original scope of the dependency that was
updated from.
Review Comment:
no period
##########
src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java:
##########
@@ -32,31 +32,70 @@ public class ConflictData {
private Boolean originaOptionality;
+ /**
+ * Construct ConflictData. Containing information about conflicts during
dependency resolution.
+ * Either this node lost the conflict and winnerVersion is set with the
versionwof the winnig node,
+ * or this node won and winnerVersion is @code{null}.
+ * If this node won ignoredScope can contain potential scopes that were
ignored during conflict resolution.
+ *
+ * @param winnerVersion the version of the dependency that was selected.
+ * @param ignoredScope the scope
+ */
public ConflictData(String winnerVersion, String ignoredScope) {
this.winnerVersion = winnerVersion;
this.ignoredScope = ignoredScope;
}
+ /**
+ * In case of a conflict, the version of the dependency that was selected.
+ *
+ * @return the version of the dependency node that was selected.
+ */
public String getWinnerVersion() {
return winnerVersion;
}
+ /**
+ * Original scope of a rejected dependency due to a conflict.
+ *
+ * @return the original scope of the dependency that was updated from.
Review Comment:
no period
##########
src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java:
##########
@@ -32,31 +32,70 @@ public class ConflictData {
private Boolean originaOptionality;
+ /**
+ * Construct ConflictData. Containing information about conflicts during
dependency resolution.
+ * Either this node lost the conflict and winnerVersion is set with the
versionwof the winnig node,
+ * or this node won and winnerVersion is @code{null}.
+ * If this node won ignoredScope can contain potential scopes that were
ignored during conflict resolution.
+ *
+ * @param winnerVersion the version of the dependency that was selected.
+ * @param ignoredScope the scope
+ */
public ConflictData(String winnerVersion, String ignoredScope) {
this.winnerVersion = winnerVersion;
this.ignoredScope = ignoredScope;
}
+ /**
+ * In case of a conflict, the version of the dependency that was selected.
+ *
+ * @return the version of the dependency node that was selected.
+ */
public String getWinnerVersion() {
return winnerVersion;
}
+ /**
+ * Original scope of a rejected dependency due to a conflict.
+ *
+ * @return the original scope of the dependency that was updated from.
+ */
public String getOriginalScope() {
return originalScope;
}
+ /**
+ * Set original scope of a rejected dependency due to a conflict.
+ *
+ * @param originalScope the original scope of the dependency that was
updated from.
+ */
public void setOriginalScope(String originalScope) {
this.originalScope = originalScope;
}
+ /**
+ * Original optionality of a rejected dependency due to a conflict.
+ *
+ * @return the original optionality of the dependency.
+ */
public Boolean getOriginaOptionality() {
Review Comment:
getOriginalOptionality?
##########
src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java:
##########
@@ -32,31 +32,70 @@ public class ConflictData {
private Boolean originaOptionality;
+ /**
+ * Construct ConflictData. Containing information about conflicts during
dependency resolution.
+ * Either this node lost the conflict and winnerVersion is set with the
versionwof the winnig node,
+ * or this node won and winnerVersion is @code{null}.
+ * If this node won ignoredScope can contain potential scopes that were
ignored during conflict resolution.
+ *
+ * @param winnerVersion the version of the dependency that was selected.
+ * @param ignoredScope the scope
+ */
public ConflictData(String winnerVersion, String ignoredScope) {
this.winnerVersion = winnerVersion;
this.ignoredScope = ignoredScope;
}
+ /**
+ * In case of a conflict, the version of the dependency that was selected.
+ *
+ * @return the version of the dependency node that was selected.
+ */
public String getWinnerVersion() {
return winnerVersion;
}
+ /**
+ * Original scope of a rejected dependency due to a conflict.
+ *
+ * @return the original scope of the dependency that was updated from.
+ */
public String getOriginalScope() {
return originalScope;
}
+ /**
+ * Set original scope of a rejected dependency due to a conflict.
+ *
+ * @param originalScope the original scope of the dependency that was
updated from.
+ */
public void setOriginalScope(String originalScope) {
this.originalScope = originalScope;
}
+ /**
+ * Original optionality of a rejected dependency due to a conflict.
+ *
+ * @return the original optionality of the dependency.
+ */
public Boolean getOriginaOptionality() {
return originaOptionality;
}
+ /**
+ * Set original optionality of a rejected dependency due to a conflict.
+ *
+ * @param originaOptionality the original optionality of the dependency.
Review Comment:
originalOptionality or originOptionality, whichever is correct
##########
src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java:
##########
@@ -32,31 +32,70 @@ public class ConflictData {
private Boolean originaOptionality;
+ /**
+ * Construct ConflictData. Containing information about conflicts during
dependency resolution.
+ * Either this node lost the conflict and winnerVersion is set with the
versionwof the winnig node,
+ * or this node won and winnerVersion is @code{null}.
+ * If this node won ignoredScope can contain potential scopes that were
ignored during conflict resolution.
+ *
+ * @param winnerVersion the version of the dependency that was selected.
+ * @param ignoredScope the scope
+ */
public ConflictData(String winnerVersion, String ignoredScope) {
this.winnerVersion = winnerVersion;
this.ignoredScope = ignoredScope;
}
+ /**
+ * In case of a conflict, the version of the dependency that was selected.
+ *
+ * @return the version of the dependency node that was selected.
Review Comment:
no period
##########
src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java:
##########
@@ -32,31 +32,70 @@ public class ConflictData {
private Boolean originaOptionality;
+ /**
+ * Construct ConflictData. Containing information about conflicts during
dependency resolution.
+ * Either this node lost the conflict and winnerVersion is set with the
versionwof the winnig node,
+ * or this node won and winnerVersion is @code{null}.
+ * If this node won ignoredScope can contain potential scopes that were
ignored during conflict resolution.
+ *
+ * @param winnerVersion the version of the dependency that was selected.
Review Comment:
nit: no period per oracle javadoc guidelines
##########
src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java:
##########
@@ -32,31 +32,70 @@ public class ConflictData {
private Boolean originaOptionality;
+ /**
+ * Construct ConflictData. Containing information about conflicts during
dependency resolution.
+ * Either this node lost the conflict and winnerVersion is set with the
versionwof the winnig node,
+ * or this node won and winnerVersion is @code{null}.
+ * If this node won ignoredScope can contain potential scopes that were
ignored during conflict resolution.
+ *
+ * @param winnerVersion the version of the dependency that was selected.
+ * @param ignoredScope the scope
+ */
public ConflictData(String winnerVersion, String ignoredScope) {
this.winnerVersion = winnerVersion;
this.ignoredScope = ignoredScope;
}
+ /**
+ * In case of a conflict, the version of the dependency that was selected.
+ *
+ * @return the version of the dependency node that was selected.
+ */
public String getWinnerVersion() {
return winnerVersion;
}
+ /**
+ * Original scope of a rejected dependency due to a conflict.
+ *
+ * @return the original scope of the dependency that was updated from.
+ */
public String getOriginalScope() {
return originalScope;
}
+ /**
+ * Set original scope of a rejected dependency due to a conflict.
+ *
+ * @param originalScope the original scope of the dependency that was
updated from.
+ */
public void setOriginalScope(String originalScope) {
this.originalScope = originalScope;
}
+ /**
+ * Original optionality of a rejected dependency due to a conflict.
+ *
+ * @return the original optionality of the dependency.
+ */
public Boolean getOriginaOptionality() {
return originaOptionality;
}
+ /**
+ * Set original optionality of a rejected dependency due to a conflict.
+ *
+ * @param originaOptionality the original optionality of the dependency.
+ */
public void setOriginaOptionality(Boolean originaOptionality) {
Review Comment:
do we actually need all these setter methods? Does anyone use them?
##########
src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java:
##########
@@ -32,31 +32,70 @@ public class ConflictData {
private Boolean originaOptionality;
+ /**
+ * Construct ConflictData. Containing information about conflicts during
dependency resolution.
+ * Either this node lost the conflict and winnerVersion is set with the
versionwof the winnig node,
+ * or this node won and winnerVersion is @code{null}.
+ * If this node won ignoredScope can contain potential scopes that were
ignored during conflict resolution.
+ *
+ * @param winnerVersion the version of the dependency that was selected.
+ * @param ignoredScope the scope
Review Comment:
what does ignored mean here? It's not obvious
##########
src/main/java/org/apache/maven/shared/dependency/graph/ConflictData.java:
##########
@@ -32,31 +32,70 @@ public class ConflictData {
private Boolean originaOptionality;
+ /**
+ * Construct ConflictData. Containing information about conflicts during
dependency resolution.
+ * Either this node lost the conflict and winnerVersion is set with the
versionwof the winnig node,
+ * or this node won and winnerVersion is @code{null}.
+ * If this node won ignoredScope can contain potential scopes that were
ignored during conflict resolution.
+ *
+ * @param winnerVersion the version of the dependency that was selected.
+ * @param ignoredScope the scope
+ */
public ConflictData(String winnerVersion, String ignoredScope) {
this.winnerVersion = winnerVersion;
this.ignoredScope = ignoredScope;
}
+ /**
+ * In case of a conflict, the version of the dependency that was selected.
+ *
+ * @return the version of the dependency node that was selected.
+ */
public String getWinnerVersion() {
return winnerVersion;
}
+ /**
+ * Original scope of a rejected dependency due to a conflict.
+ *
+ * @return the original scope of the dependency that was updated from.
+ */
public String getOriginalScope() {
return originalScope;
}
+ /**
+ * Set original scope of a rejected dependency due to a conflict.
+ *
+ * @param originalScope the original scope of the dependency that was
updated from.
+ */
public void setOriginalScope(String originalScope) {
this.originalScope = originalScope;
}
+ /**
+ * Original optionality of a rejected dependency due to a conflict.
+ *
+ * @return the original optionality of the dependency.
+ */
public Boolean getOriginaOptionality() {
return originaOptionality;
}
+ /**
+ * Set original optionality of a rejected dependency due to a conflict.
+ *
+ * @param originaOptionality the original optionality of the dependency.
+ */
public void setOriginaOptionality(Boolean originaOptionality) {
this.originaOptionality = originaOptionality;
}
+ /**
+ * The scope of the dependency that was not updated to during dependency
resolution.
+ *
+ * @return the scope of the dependency that was ignored and not updated to.
Review Comment:
no period
##########
src/test/java/org/apache/maven/shared/dependency/graph/internal/DefaultDependencyNodeTest.java:
##########
@@ -42,4 +42,12 @@ public void
nodeString_for_mandatory_depenendency_does_not_contain_optional_info
new DefaultDependencyNode(null, artifact, "1.0", "compile",
"1.0", false, emptyList());
assertEquals("group:artifact:jar:1.2:compile",
optionalNode.toNodeString());
}
+
+ @Test
+ public void defaultDependencyNode_should_return_null_conflict_data() {
Review Comment:
Maybe just defaultDependencyNodeHasNullConflictData
> Conflict Data on VerboseDependencyNode is hidden
> ------------------------------------------------
>
> Key: MSHARED-1454
> URL: https://issues.apache.org/jira/browse/MSHARED-1454
> Project: Maven Shared Components
> Issue Type: New Feature
> Components: maven-dependency-tree
> Reporter: Elias Lundell
> Priority: Minor
> Labels: pull-request-available
>
> In maven-dependency-plugin there are multiple export formats for the
> dependency tree, these include Json, DOT, GraphML etc. When creating the
> normal tree all information is there to format it nicely as e.g. Json.
> However, when running `{{{}mvn dependency:tree -Dverbose{}}}`, all nodes are
> included (as they are VerboseDependencyNode) but since VerboseDependencyNode
> is internal in maven-dependency-tree there is no (clean) way to include
> information of which nodes are included or not (see
> https://issues.apache.org/jira/browse/MDEP-962).
> The only current way to include this information would be to parse the
> `{{{}toNodeString(){}}}` output (where excluded nodes are wrapped in
> parenthesis).
> I propose to expose ConflictData on the DependencyNode and make it null for
> DefaultDependencyNode to allow for more detailed information in the
> machine-readable formats.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
