You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2022/12/18 16:56:25 UTC

[maven] branch maven-3.9.x updated: Implement some #toString() methods

This is an automated email from the ASF dual-hosted git repository.

michaelo pushed a commit to branch maven-3.9.x
in repository https://gitbox.apache.org/repos/asf/maven.git


The following commit(s) were added to refs/heads/maven-3.9.x by this push:
     new 4adaf2abc Implement some #toString() methods
4adaf2abc is described below

commit 4adaf2abca4e3018b92c0c03e07c50a6b1a8ddab
Author: Piotrek Żygieło <pz...@users.noreply.github.com>
AuthorDate: Mon Jan 17 16:23:28 2022 +0100

    Implement some #toString() methods
    
    * Implement Developer#toString()
    * Implement IssueManagement#toString()
    * Implement License#toString()
    * Implement Build#toString()
    * Implement Organization#toString()
    * Implement MailingList#toString()
    * Implement Scm#toString()
    
    This closes #923
---
 maven-model/src/main/mdo/maven.mdo                 | 170 +++++++++++++++++++++
 .../java/org/apache/maven/model/BuildTest.java     |   8 +
 .../java/org/apache/maven/model/DeveloperTest.java |  11 ++
 .../apache/maven/model/IssueManagementTest.java    |  10 ++
 .../java/org/apache/maven/model/LicenseTest.java   |  10 ++
 .../org/apache/maven/model/MailingListTest.java    |   9 ++
 .../org/apache/maven/model/OrganizationTest.java   |  28 ++++
 .../test/java/org/apache/maven/model/ScmTest.java  |   9 ++
 8 files changed, 255 insertions(+)

diff --git a/maven-model/src/main/mdo/maven.mdo b/maven-model/src/main/mdo/maven.mdo
index 41f23919f..2bd344e1b 100644
--- a/maven-model/src/main/mdo/maven.mdo
+++ b/maven-model/src/main/mdo/maven.mdo
@@ -618,6 +618,18 @@
             ]]>
           </code>
         </codeSegment>
+        <codeSegment>
+          <version>4.0.0+</version>
+          <code>
+            <![CDATA[
+     @Override
+     public String toString()
+     {
+         return "PluginContainer {}";
+     }
+            ]]>
+          </code>
+        </codeSegment>
       </codeSegments>
     </class>
     <class>
@@ -641,6 +653,22 @@
           </association>
         </field>
       </fields>
+      <codeSegments>
+        <codeSegment>
+          <version>4.0.0+</version>
+          <code>
+            <![CDATA[
+    /**
+     * @see java.lang.Object#toString()
+     */
+    public String toString()
+    {
+        return "PluginConfiguration {" + super.toString() + "}";
+    }
+            ]]>
+          </code>
+        </codeSegment>
+      </codeSegments>
     </class>
     <class xdoc.anchorName="profile_build">
       <name>BuildBase</name>
@@ -715,6 +743,22 @@
           </association>
         </field>
       </fields>
+      <codeSegments>
+        <codeSegment>
+          <version>4.0.0+</version>
+          <code>
+            <![CDATA[
+    /**
+     * @see java.lang.Object#toString()
+     */
+    public String toString()
+    {
+        return "BuildBase {" + super.toString() + "}";
+    }
+            ]]>
+          </code>
+        </codeSegment>
+      </codeSegments>
     </class>
     <class>
       <name>Build</name>
@@ -792,6 +836,22 @@
           </association>
         </field>
       </fields>
+      <codeSegments>
+        <codeSegment>
+          <version>4.0.0+</version>
+          <code>
+            <![CDATA[
+    /**
+     * @see java.lang.Object#toString()
+     */
+    public String toString()
+    {
+        return "Build {" + super.toString() + "}";
+    }
+            ]]>
+          </code>
+        </codeSegment>
+      </codeSegments>
     </class>
     <class java.clone="deep">
       <name>CiManagement</name>
@@ -971,6 +1031,22 @@
           </association>
         </field>
       </fields>
+      <codeSegments>
+        <codeSegment>
+          <version>4.0.0+</version>
+          <code>
+            <![CDATA[
+    /**
+     * @see java.lang.Object#toString()
+     */
+    public String toString()
+    {
+        return "Contributor {name=" + name + ", email=" + email + "}";
+    }
+            ]]>
+          </code>
+        </codeSegment>
+      </codeSegments>
     </class>
     <class java.clone="deep">
       <name>Dependency</name>
@@ -1179,6 +1255,22 @@
           <type>String</type>
         </field>
       </fields>
+      <codeSegments>
+        <codeSegment>
+          <version>4.0.0+</version>
+          <code>
+            <![CDATA[
+    /**
+     * @see java.lang.Object#toString()
+     */
+    public String toString()
+    {
+        return "Developer {id=" + id + ", " + super.toString() + "}";
+    }
+            ]]>
+          </code>
+        </codeSegment>
+      </codeSegments>
     </class>
     <class java.clone="deep">
       <name>Exclusion</name>
@@ -1225,6 +1317,22 @@
           <type>String</type>
         </field>
       </fields>
+      <codeSegments>
+        <codeSegment>
+          <version>4.0.0+</version>
+          <code>
+            <![CDATA[
+    /**
+     * @see java.lang.Object#toString()
+     */
+    public String toString()
+    {
+        return "IssueManagement {system=" + system + ", url=" + url + "}";
+    }
+            ]]>
+          </code>
+        </codeSegment>
+      </codeSegments>
     </class>
     <class java.clone="deep">
       <name>DistributionManagement</name>
@@ -1346,6 +1454,22 @@
           <type>String</type>
         </field>
       </fields>
+      <codeSegments>
+        <codeSegment>
+          <version>4.0.0+</version>
+          <code>
+            <![CDATA[
+    /**
+     * @see java.lang.Object#toString()
+     */
+    public String toString()
+    {
+        return "License {name=" + name + ", url=" + url + "}";
+    }
+            ]]>
+          </code>
+        </codeSegment>
+      </codeSegments>
     </class>
     <class java.clone="deep">
       <name>MailingList</name>
@@ -1421,6 +1545,22 @@
       <comment>We could probably have a specific element for a dev mailing list for things like CI,
         and maybe even a specific element for the user and scm mailing lists. Then leave the more
         lose structure for any other type of mailing list.</comment>
+      <codeSegments>
+        <codeSegment>
+          <version>4.0.0+</version>
+          <code>
+            <![CDATA[
+    /**
+     * @see java.lang.Object#toString()
+     */
+    public String toString()
+    {
+        return "MailingList {name=" + name + ", archive=" + archive + "}";
+    }
+            ]]>
+          </code>
+        </codeSegment>
+      </codeSegments>
     </class>
     <class java.clone="deep">
       <name>Organization</name>
@@ -1440,6 +1580,22 @@
           <type>String</type>
         </field>
       </fields>
+      <codeSegments>
+        <codeSegment>
+          <version>4.0.0+</version>
+          <code>
+            <![CDATA[
+    /**
+     * @see java.lang.Object#toString()
+     */
+    public String toString()
+    {
+        return "Organization {name=" + name + ", url=" + url + "}";
+    }
+            ]]>
+          </code>
+        </codeSegment>
+      </codeSegments>
     </class>
     <class java.clone="deep">
       <name>PatternSet</name>
@@ -1737,6 +1893,20 @@
             ]]>
           </code>
         </codeSegment>
+        <codeSegment>
+          <version>4.0.0+</version>
+          <code>
+            <![CDATA[
+    /**
+     * @see java.lang.Object#toString()
+     */
+    public String toString()
+    {
+        return "Scm {connection=" + connection + "}";
+    }
+            ]]>
+          </code>
+        </codeSegment>
       </codeSegments>
     </class>
     <class>
diff --git a/maven-model/src/test/java/org/apache/maven/model/BuildTest.java b/maven-model/src/test/java/org/apache/maven/model/BuildTest.java
index 2512d3cc4..d1343a648 100644
--- a/maven-model/src/test/java/org/apache/maven/model/BuildTest.java
+++ b/maven-model/src/test/java/org/apache/maven/model/BuildTest.java
@@ -45,4 +45,12 @@ public class BuildTest extends TestCase {
     public void testToStringNullSafe() {
         assertNotNull(new Build().toString());
     }
+
+    public void testToStringNotNonsense() {
+        Build build = new Build();
+
+        String s = build.toString();
+
+        assert "Build {BuildBase {PluginConfiguration {PluginContainer {}}}}".equals(s) : s;
+    }
 }
diff --git a/maven-model/src/test/java/org/apache/maven/model/DeveloperTest.java b/maven-model/src/test/java/org/apache/maven/model/DeveloperTest.java
index cc29e4dd4..e54767e28 100644
--- a/maven-model/src/test/java/org/apache/maven/model/DeveloperTest.java
+++ b/maven-model/src/test/java/org/apache/maven/model/DeveloperTest.java
@@ -45,4 +45,15 @@ public class DeveloperTest extends TestCase {
     public void testToStringNullSafe() {
         assertNotNull(new Developer().toString());
     }
+
+    public void testToStringNotNonsense() {
+        Developer dev = new Developer();
+        dev.setName("Maven Tester");
+        dev.setEmail("tester@acme.localdomain");
+        dev.setId("20220118");
+
+        String s = dev.toString();
+
+        assert "Developer {id=20220118, Contributor {name=Maven Tester, email=tester@acme.localdomain}}".equals(s) : s;
+    }
 }
diff --git a/maven-model/src/test/java/org/apache/maven/model/IssueManagementTest.java b/maven-model/src/test/java/org/apache/maven/model/IssueManagementTest.java
index 5a30d1c1e..371030b41 100644
--- a/maven-model/src/test/java/org/apache/maven/model/IssueManagementTest.java
+++ b/maven-model/src/test/java/org/apache/maven/model/IssueManagementTest.java
@@ -45,4 +45,14 @@ public class IssueManagementTest extends TestCase {
     public void testToStringNullSafe() {
         assertNotNull(new IssueManagement().toString());
     }
+
+    public void testToStringNotNonsense() {
+        IssueManagement im = new IssueManagement();
+        im.setSystem("Velociraptor");
+        im.setUrl("https://velo.localdomain");
+
+        String s = im.toString();
+
+        assert "IssueManagement {system=Velociraptor, url=https://velo.localdomain}".equals(s) : s;
+    }
 }
diff --git a/maven-model/src/test/java/org/apache/maven/model/LicenseTest.java b/maven-model/src/test/java/org/apache/maven/model/LicenseTest.java
index 4739726be..a8f5b81dc 100644
--- a/maven-model/src/test/java/org/apache/maven/model/LicenseTest.java
+++ b/maven-model/src/test/java/org/apache/maven/model/LicenseTest.java
@@ -45,4 +45,14 @@ public class LicenseTest extends TestCase {
     public void testToStringNullSafe() {
         assertNotNull(new License().toString());
     }
+
+    public void testToStringNotNonsense() {
+        License license = new License();
+        license.setName("Unlicense");
+        license.setUrl("http://lic.localdomain");
+
+        String s = license.toString();
+
+        assert "License {name=Unlicense, url=http://lic.localdomain}".equals(s) : s;
+    }
 }
diff --git a/maven-model/src/test/java/org/apache/maven/model/MailingListTest.java b/maven-model/src/test/java/org/apache/maven/model/MailingListTest.java
index 3817cc06a..ba0cd7620 100644
--- a/maven-model/src/test/java/org/apache/maven/model/MailingListTest.java
+++ b/maven-model/src/test/java/org/apache/maven/model/MailingListTest.java
@@ -45,4 +45,13 @@ public class MailingListTest extends TestCase {
     public void testToStringNullSafe() {
         assertNotNull(new MailingList().toString());
     }
+
+    public void testToStringNotNonsense() {
+        MailingList list = new MailingList();
+        list.setName("modello-dev");
+
+        String s = list.toString();
+
+        assertEquals("MailingList {name=modello-dev, archive=null}", s);
+    }
 }
diff --git a/maven-model/src/test/java/org/apache/maven/model/OrganizationTest.java b/maven-model/src/test/java/org/apache/maven/model/OrganizationTest.java
index 72a1994f9..468cc3974 100644
--- a/maven-model/src/test/java/org/apache/maven/model/OrganizationTest.java
+++ b/maven-model/src/test/java/org/apache/maven/model/OrganizationTest.java
@@ -45,4 +45,32 @@ public class OrganizationTest extends TestCase {
     public void testToStringNullSafe() {
         assertNotNull(new Organization().toString());
     }
+
+    public void testToStringNotNonsense11() {
+        Organization org = new Organization();
+        org.setName("Testing Maven Unit");
+        org.setUrl("https://maven.localdomain");
+
+        assertEquals("Organization {name=Testing Maven Unit, url=https://maven.localdomain}", org.toString());
+    }
+
+    public void testToStringNotNonsense10() {
+        Organization org = new Organization();
+        org.setName("Testing Maven Unit");
+
+        assertEquals("Organization {name=Testing Maven Unit, url=null}", org.toString());
+    }
+
+    public void testToStringNotNonsense01() {
+        Organization org = new Organization();
+        org.setUrl("https://maven.localdomain");
+
+        assertEquals("Organization {name=null, url=https://maven.localdomain}", org.toString());
+    }
+
+    public void testToStringNotNonsense00() {
+        Organization org = new Organization();
+
+        assertEquals("Organization {name=null, url=null}", org.toString());
+    }
 }
diff --git a/maven-model/src/test/java/org/apache/maven/model/ScmTest.java b/maven-model/src/test/java/org/apache/maven/model/ScmTest.java
index f4a374838..e733c10f5 100644
--- a/maven-model/src/test/java/org/apache/maven/model/ScmTest.java
+++ b/maven-model/src/test/java/org/apache/maven/model/ScmTest.java
@@ -45,4 +45,13 @@ public class ScmTest extends TestCase {
     public void testToStringNullSafe() {
         assertNotNull(new Scm().toString());
     }
+
+    public void testToStringNotNonsense() {
+        Scm scm = new Scm();
+        scm.setConnection("scm:git:git://git.localdomain/model");
+
+        String s = scm.toString();
+
+        assertEquals("Scm {connection=scm:git:git://git.localdomain/model}", s);
+    }
 }