You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@creadur.apache.org by rd...@apache.org on 2013/12/06 20:30:06 UTC

svn commit: r1548685 - in /creadur/rat/branches/gsoc: apache-rat-api/src/main/java/org/apache/rat/api/domain/ apache-rat-api/src/test/java/org/apache/rat/api/domain/ apache-rat-core/src/main/java/org/apache/rat/api/ apache-rat-core/src/main/java/org/ap...

Author: rdonkin
Date: Fri Dec  6 19:30:05 2013
New Revision: 1548685

URL: http://svn.apache.org/r1548685
Log:
Factor out enum, giving more fluent access to data about licenses.

Added:
    creadur/rat/branches/gsoc/apache-rat-api/src/main/java/org/apache/rat/api/domain/RatLicenseFamily.java
      - copied, changed from r1548684, creadur/rat/branches/gsoc/apache-rat-api/src/main/java/org/apache/rat/api/domain/LicenseFamilyFactory.java
Modified:
    creadur/rat/branches/gsoc/apache-rat-api/src/main/java/org/apache/rat/api/domain/LicenseFamilyFactory.java
    creadur/rat/branches/gsoc/apache-rat-api/src/test/java/org/apache/rat/api/domain/LicenseFamilyFactoryTest.java
    creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java
    creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/license/W3CSoftwareLicenseFamily.java
    creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/policy/DefaultPolicy.java

Modified: creadur/rat/branches/gsoc/apache-rat-api/src/main/java/org/apache/rat/api/domain/LicenseFamilyFactory.java
URL: http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-api/src/main/java/org/apache/rat/api/domain/LicenseFamilyFactory.java?rev=1548685&r1=1548684&r2=1548685&view=diff
==============================================================================
--- creadur/rat/branches/gsoc/apache-rat-api/src/main/java/org/apache/rat/api/domain/LicenseFamilyFactory.java (original)
+++ creadur/rat/branches/gsoc/apache-rat-api/src/main/java/org/apache/rat/api/domain/LicenseFamilyFactory.java Fri Dec  6 19:30:05 2013
@@ -18,22 +18,16 @@
  */
 package org.apache.rat.api.domain;
 
-import static org.apache.rat.api.domain.LicenseFamilyBuilder.aLicenseFamily;
+import static org.apache.rat.api.domain.RatLicenseFamily.W3C;
 
 public final class LicenseFamilyFactory {
 
-    public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C = "W3C  ";
-    public static final String RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT =
-            "W3C Software Copyright";
 
     private LicenseFamilyFactory() {
     }
 
     public static LicenseFamily w3c() {
-        return aLicenseFamily()
-                .withCategory(RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C)
-               .withName(RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT)
-                .withNotes("").build();
+        return W3C.licenseFamily();
     }
 
 }

Copied: creadur/rat/branches/gsoc/apache-rat-api/src/main/java/org/apache/rat/api/domain/RatLicenseFamily.java (from r1548684, creadur/rat/branches/gsoc/apache-rat-api/src/main/java/org/apache/rat/api/domain/LicenseFamilyFactory.java)
URL: http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-api/src/main/java/org/apache/rat/api/domain/RatLicenseFamily.java?p2=creadur/rat/branches/gsoc/apache-rat-api/src/main/java/org/apache/rat/api/domain/RatLicenseFamily.java&p1=creadur/rat/branches/gsoc/apache-rat-api/src/main/java/org/apache/rat/api/domain/LicenseFamilyFactory.java&r1=1548684&r2=1548685&rev=1548685&view=diff
==============================================================================
--- creadur/rat/branches/gsoc/apache-rat-api/src/main/java/org/apache/rat/api/domain/LicenseFamilyFactory.java (original)
+++ creadur/rat/branches/gsoc/apache-rat-api/src/main/java/org/apache/rat/api/domain/RatLicenseFamily.java Fri Dec  6 19:30:05 2013
@@ -20,20 +20,37 @@ package org.apache.rat.api.domain;
 
 import static org.apache.rat.api.domain.LicenseFamilyBuilder.aLicenseFamily;
 
-public final class LicenseFamilyFactory {
+public enum RatLicenseFamily {
 
-    public static final String RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C = "W3C  ";
-    public static final String RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT =
-            "W3C Software Copyright";
+    W3C("W3C Software Copyright", "W3C  ", "");
 
-    private LicenseFamilyFactory() {
+    private final String name;
+    private final String category;
+    private final String notes;
+    private final LicenseFamily licenseFamily;
+
+    private RatLicenseFamily(final String name, final String category,
+            final String notes) {
+        this.name = name;
+        this.category = category;
+        this.notes = notes;
+        this.licenseFamily = aLicenseFamily().withCategory(getCategory())
+                .withName(getName()).withNotes(getNotes()).build();
     }
 
-    public static LicenseFamily w3c() {
-        return aLicenseFamily()
-                .withCategory(RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C)
-               .withName(RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT)
-                .withNotes("").build();
+    public String getName() {
+        return this.name;
     }
 
+    public String getCategory() {
+        return this.category;
+    }
+
+    public String getNotes() {
+        return this.notes;
+    }
+
+    public LicenseFamily licenseFamily() {
+        return this.licenseFamily;
+    }
 }

Modified: creadur/rat/branches/gsoc/apache-rat-api/src/test/java/org/apache/rat/api/domain/LicenseFamilyFactoryTest.java
URL: http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-api/src/test/java/org/apache/rat/api/domain/LicenseFamilyFactoryTest.java?rev=1548685&r1=1548684&r2=1548685&view=diff
==============================================================================
--- creadur/rat/branches/gsoc/apache-rat-api/src/test/java/org/apache/rat/api/domain/LicenseFamilyFactoryTest.java (original)
+++ creadur/rat/branches/gsoc/apache-rat-api/src/test/java/org/apache/rat/api/domain/LicenseFamilyFactoryTest.java Fri Dec  6 19:30:05 2013
@@ -22,6 +22,7 @@ import static org.hamcrest.CoreMatchers.
 import static org.junit.Assert.assertThat;
 
 import org.junit.Test;
+import static org.apache.rat.api.domain.RatLicenseFamily.W3C;
 
 public class LicenseFamilyFactoryTest {
 
@@ -29,7 +30,7 @@ public class LicenseFamilyFactoryTest {
     public void testW3CLicenseFamilyCategory() {
         final LicenseFamily family = LicenseFamilyFactory.w3c();
         assertThat(family.getCategory(),
-                is(LicenseFamilyFactory.RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C));
+                is(W3C.getCategory()));
     }
 
     @Test
@@ -37,7 +38,7 @@ public class LicenseFamilyFactoryTest {
         final LicenseFamily family = LicenseFamilyFactory.w3c();
         assertThat(
                 family.getName(),
-                is(LicenseFamilyFactory.RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT));
+                is(W3C.getName()));
     }
 
     @Test

Modified: creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java
URL: http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java?rev=1548685&r1=1548684&r2=1548685&view=diff
==============================================================================
--- creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java (original)
+++ creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/api/MetaData.java Fri Dec  6 19:30:05 2013
@@ -18,13 +18,14 @@
  */
 package org.apache.rat.api;
 
+import static org.apache.rat.api.domain.RatLicenseFamily.W3C;
+
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Iterator;
 import java.util.List;
 
-import org.apache.rat.api.domain.LicenseFamilyFactory;
 
 /**
  * Data about the subject.
@@ -93,7 +94,7 @@ public class MetaData {
             RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3CD);
     public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_W3C = new Datum(
             RAT_URL_LICENSE_FAMILY_CATEGORY,
-            LicenseFamilyFactory.RAT_LICENSE_FAMILY_CATEGORY_VALUE_W3C);
+            W3C.getCategory());
     public static final Datum RAT_LICENSE_FAMILY_CATEGORY_DATUM_DOJO = new Datum(
             RAT_URL_LICENSE_FAMILY_CATEGORY,
             RAT_LICENSE_FAMILY_CATEGORY_VALUE_DOJO);
@@ -132,7 +133,7 @@ public class MetaData {
     public static final String RAT_LICENSE_FAMILY_NAME_VALUE_UNKNOWN = "?????";
     public static final Datum RAT_LICENSE_FAMILY_NAME_DATUM_W3C_SOFTWARE_COPYRIGHT = new Datum(
             RAT_URL_LICENSE_FAMILY_NAME,
-            LicenseFamilyFactory.RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT);
+            W3C.getName());
     public static final Datum RAT_LICENSE_FAMILY_NAME_DATUM_W3C_DOCUMENT_COPYRIGHT = new Datum(
             RAT_URL_LICENSE_FAMILY_NAME,
             RAT_LICENSE_FAMILY_NAME_VALUE_W3C_DOCUMENT_COPYRIGHT);

Modified: creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/license/W3CSoftwareLicenseFamily.java
URL: http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/license/W3CSoftwareLicenseFamily.java?rev=1548685&r1=1548684&r2=1548685&view=diff
==============================================================================
--- creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/license/W3CSoftwareLicenseFamily.java (original)
+++ creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/license/W3CSoftwareLicenseFamily.java Fri Dec  6 19:30:05 2013
@@ -18,10 +18,10 @@
  */
 package org.apache.rat.license;
 
-import org.apache.rat.api.domain.LicenseFamilyFactory;
+import static org.apache.rat.api.domain.RatLicenseFamily.W3C;
 
 public class W3CSoftwareLicenseFamily extends SimpleLicenseFamily {
     public W3CSoftwareLicenseFamily() {
-        super(LicenseFamilyFactory.RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT);
+        super(W3C.getName());
     }
 }

Modified: creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/policy/DefaultPolicy.java
URL: http://svn.apache.org/viewvc/creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/policy/DefaultPolicy.java?rev=1548685&r1=1548684&r2=1548685&view=diff
==============================================================================
--- creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/policy/DefaultPolicy.java (original)
+++ creadur/rat/branches/gsoc/apache-rat-core/src/main/java/org/apache/rat/policy/DefaultPolicy.java Fri Dec  6 19:30:05 2013
@@ -18,12 +18,13 @@
  */
 package org.apache.rat.policy;
 
+import static org.apache.rat.api.domain.RatLicenseFamily.W3C;
+
 import org.apache.rat.api.Document;
 import org.apache.rat.api.MetaData;
 import org.apache.rat.api.MetaData.Datum;
 import org.apache.rat.document.IDocumentAnalyser;
 import org.apache.rat.license.ILicenseFamily;
-import org.apache.rat.api.domain.LicenseFamilyFactory;
 
 import java.util.Arrays;
 
@@ -31,7 +32,7 @@ public class DefaultPolicy implements ID
     private static final String[] APPROVED_LICENSES = {
         MetaData.RAT_LICENSE_FAMILY_NAME_VALUE_APACHE_LICENSE_VERSION_2_0,
         MetaData.RAT_LICENSE_FAMILY_NAME_VALUE_OASIS_OPEN_LICENSE,
-        LicenseFamilyFactory.RAT_LICENSE_FAMILY_NAME_VALUE_W3C_SOFTWARE_COPYRIGHT,
+        W3C.getName(),
         MetaData.RAT_LICENSE_FAMILY_NAME_VALUE_W3C_DOCUMENT_COPYRIGHT,
         MetaData.RAT_LICENSE_FAMILY_NAME_VALUE_MODIFIED_BSD_LICENSE,
         MetaData.RAT_LICENSE_FAMILY_NAME_VALUE_MIT,