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 2012/05/20 14:30:39 UTC
svn commit: r1340695 -
/creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/
Author: rdonkin
Date: Sun May 20 12:30:38 2012
New Revision: 1340695
URL: http://svn.apache.org/viewvc?rev=1340695&view=rev
Log:
Ran Eclipse clean up on the code, aiming for better compliance with checkstyle...
Modified:
creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/ByOrganisation.java
creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Descriptor.java
creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/License.java
creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.java
creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/LicenseTemplateException.java
creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/NoticeCollator.java
creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Organisation.java
creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Resource.java
creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/ResourceNamesCollator.java
creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Visitor.java
creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/WithLicense.java
creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/WithinDirectory.java
Modified: creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/ByOrganisation.java
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/ByOrganisation.java?rev=1340695&r1=1340694&r2=1340695&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/ByOrganisation.java (original)
+++ creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/ByOrganisation.java Sun May 20 12:30:38 2012
@@ -24,42 +24,44 @@ import java.util.Collection;
*
*/
public class ByOrganisation implements Comparable<ByOrganisation> {
-
+
private final Organisation organisation;
private final Collection<Resource> resources;
-
-
+
/**
- * @param resources not null
- * @param organisation not null
+ * @param resources
+ * not null
+ * @param organisation
+ * not null
*/
- public ByOrganisation(final Organisation organisation, final Collection<Resource> resources) {
+ public ByOrganisation(final Organisation organisation,
+ final Collection<Resource> resources) {
super();
this.organisation = organisation;
this.resources = resources;
}
public String getName() {
- return organisation.getName();
+ return this.organisation.getName();
}
-
+
public String getURL() {
- return organisation.getURL();
+ return this.organisation.getURL();
}
-
+
public String getId() {
- return organisation.getId();
+ return this.organisation.getId();
}
-
+
public Collection<Resource> getResources() {
- return resources;
+ return this.resources;
}
-
+
/**
* @return the organisation
*/
public Organisation getOrganisation() {
- return organisation;
+ return this.organisation;
}
/**
@@ -69,8 +71,10 @@ public class ByOrganisation implements C
public int hashCode() {
final int prime = 31;
int result = 1;
- result = prime * result
- + ((organisation == null) ? 0 : organisation.hashCode());
+ result = prime
+ * result
+ + ((this.organisation == null) ? 0 : this.organisation
+ .hashCode());
return result;
}
@@ -78,36 +82,41 @@ public class ByOrganisation implements C
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
- public boolean equals(Object obj) {
- if (this == obj)
+ public boolean equals(final Object obj) {
+ if (this == obj) {
return true;
- if (obj == null)
+ }
+ if (obj == null) {
return false;
- if (getClass() != obj.getClass())
+ }
+ if (getClass() != obj.getClass()) {
return false;
- ByOrganisation other = (ByOrganisation) obj;
- if (organisation == null) {
- if (other.organisation != null)
+ }
+ final ByOrganisation other = (ByOrganisation) obj;
+ if (this.organisation == null) {
+ if (other.organisation != null) {
return false;
- } else if (!organisation.equals(other.organisation))
+ }
+ } else if (!this.organisation.equals(other.organisation)) {
return false;
+ }
return true;
}
/**
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
- public int compareTo(ByOrganisation other) {
- return organisation.compareTo(other.getOrganisation());
+ public int compareTo(final ByOrganisation other) {
+ return this.organisation.compareTo(other.getOrganisation());
}
/**
* @param visitor
*/
- public void accept(Visitor visitor) {
+ public void accept(final Visitor visitor) {
if (visitor != null && visitor.traverseByOrganisation()) {
visitor.visit(this);
- for (final Resource resource: getResources()) {
+ for (final Resource resource : getResources()) {
resource.accept(visitor);
}
}
@@ -115,7 +124,7 @@ public class ByOrganisation implements C
@Override
public String toString() {
- return "ByOrganisation [organisation=" + organisation + ", resources="
- + resources + "]";
+ return "ByOrganisation [organisation=" + this.organisation
+ + ", resources=" + this.resources + "]";
}
}
Modified: creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Descriptor.java
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Descriptor.java?rev=1340695&r1=1340694&r2=1340695&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Descriptor.java (original)
+++ creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Descriptor.java Sun May 20 12:30:38 2012
@@ -22,24 +22,24 @@ import java.util.Collection;
import java.util.Map;
import java.util.Set;
-
/**
*
*/
public class Descriptor {
-
+
private final License primaryLicense;
private final String primaryOrganisationId;
private final String primaryNotice;
private final Map<String, License> licenses;
private final Map<String, String> notices;
private final Collection<WithinDirectory> contents;
-
- public Descriptor(License primaryLicense, String primaryOrganisationId,
- String primaryNotice, Map<String, License> licenses,
- Map<String, String> notices,
- Map<String, Organisation> organisations,
- Collection<WithinDirectory> contents) {
+
+ public Descriptor(final License primaryLicense,
+ final String primaryOrganisationId, final String primaryNotice,
+ final Map<String, License> licenses,
+ final Map<String, String> notices,
+ final Map<String, Organisation> organisations,
+ final Collection<WithinDirectory> contents) {
super();
this.primaryLicense = primaryLicense;
this.primaryOrganisationId = primaryOrganisationId;
@@ -53,7 +53,7 @@ public class Descriptor {
* @return the primaryNotice
*/
public String getPrimaryNotice() {
- return primaryNotice;
+ return this.primaryNotice;
}
public Map<String, Collection<Resource>> getResourceNotices() {
@@ -61,53 +61,56 @@ public class Descriptor {
traverse(collator);
return collator.resourceNotices(this.notices);
}
-
+
public Set<String> getOtherNotices() {
final NoticeCollator collator = new NoticeCollator();
traverse(collator);
- return collator.notices(notices);
+ return collator.notices(this.notices);
}
public License license(final String id) {
- return licenses.get(id);
+ return this.licenses.get(id);
}
-
+
public License getPrimaryLicense() {
- return primaryLicense;
+ return this.primaryLicense;
}
-
+
public Collection<WithinDirectory> getContents() {
- return contents;
+ return this.contents;
}
-
- public boolean isPrimary( final License license) {
+
+ public boolean isPrimary(final License license) {
return this.primaryLicense.equals(license);
}
-
- public boolean isPrimary( final ByOrganisation byOrganisation ) {
- return byOrganisation.getId().equals(primaryOrganisationId);
+
+ public boolean isPrimary(final ByOrganisation byOrganisation) {
+ return byOrganisation.getId().equals(this.primaryOrganisationId);
}
-
- public boolean isOnlyPrimary (final WithinDirectory directory) {
+
+ public boolean isOnlyPrimary(final WithinDirectory directory) {
final LicenseAndOrganisationCollator collator = new LicenseAndOrganisationCollator();
directory.accept(collator);
- return collator.isOnlyLicense(getPrimaryLicense()) && collator.isOnlyOrganisation(primaryOrganisationId);
+ return collator.isOnlyLicense(getPrimaryLicense())
+ && collator.isOnlyOrganisation(this.primaryOrganisationId);
}
-
- public boolean isOnlyPrimary (final WithLicense license) {
+
+ public boolean isOnlyPrimary(final WithLicense license) {
final LicenseAndOrganisationCollator collator = new LicenseAndOrganisationCollator();
license.accept(collator);
- return collator.isOnlyLicense(getPrimaryLicense()) && collator.isOnlyOrganisation(primaryOrganisationId);
+ return collator.isOnlyLicense(getPrimaryLicense())
+ && collator.isOnlyOrganisation(this.primaryOrganisationId);
}
-
+
public void traverse(final Visitor visitor) {
- for (final WithinDirectory directory: getContents()) {
+ for (final WithinDirectory directory : getContents()) {
directory.accept(visitor);
}
}
-
- public void traverseDirectory(final Visitor visitor, final String directoryName) {
- for (final WithinDirectory directory: getContents()) {
+
+ public void traverseDirectory(final Visitor visitor,
+ final String directoryName) {
+ for (final WithinDirectory directory : getContents()) {
if (directory.isNamed(directoryName)) {
directory.accept(visitor);
}
Modified: creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/License.java
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/License.java?rev=1340695&r1=1340694&r2=1340695&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/License.java (original)
+++ creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/License.java Sun May 20 12:30:38 2012
@@ -34,54 +34,60 @@ public class License implements Comparab
private final String id;
private final String url;
private final String name;
-
- public License(boolean isSourceRequired, String baseText,
- Collection<String> expectedParameters, String id, String url,
- String name) {
+
+ public License(final boolean isSourceRequired, final String baseText,
+ final Collection<String> expectedParameters, final String id,
+ final String url, final String name) {
super();
this.isSourceRequired = isSourceRequired;
this.baseText = baseText;
- this.expectedParameters = Collections.unmodifiableCollection(expectedParameters);
+ this.expectedParameters = Collections
+ .unmodifiableCollection(expectedParameters);
this.id = id;
this.url = url;
this.name = name;
}
public boolean isSourceRequired() {
- return isSourceRequired;
+ return this.isSourceRequired;
}
-
+
public String getText() throws LicenseTemplateException {
return getText(null);
}
-
- public String getText(final Map<String, String> parameters) throws LicenseTemplateException {
- return substituteInto(validate(parameters), baseText);
+
+ public String getText(final Map<String, String> parameters)
+ throws LicenseTemplateException {
+ return substituteInto(validate(parameters), this.baseText);
}
-
+
public Collection<String> getExpectedParameters() {
- return expectedParameters;
+ return this.expectedParameters;
}
/**
* @param parameters
* @return
- * @throws LicenseTemplateException
+ * @throws LicenseTemplateException
*/
@SuppressWarnings("unchecked")
- private Map<String, String> validate(final Map<String, String> parameters) throws LicenseTemplateException {
+ private Map<String, String> validate(final Map<String, String> parameters)
+ throws LicenseTemplateException {
if (parameters == null) {
return validate(Collections.EMPTY_MAP);
}
-
- if (expectedParameters.isEmpty() && parameters != null && !parameters.isEmpty()) {
- throw LicenseTemplateException.notLicenseTemplate(parameters, getName());
- }
-
- if (!parametersMatch(parameters, expectedParameters)) {
- throw LicenseTemplateException.parameterMismatch(expectedParameters, parameters.keySet());
+
+ if (this.expectedParameters.isEmpty() && parameters != null
+ && !parameters.isEmpty()) {
+ throw LicenseTemplateException.notLicenseTemplate(parameters,
+ getName());
+ }
+
+ if (!parametersMatch(parameters, this.expectedParameters)) {
+ throw LicenseTemplateException.parameterMismatch(
+ this.expectedParameters, parameters.keySet());
}
-
+
return parameters;
}
@@ -93,21 +99,23 @@ public class License implements Comparab
private boolean parametersMatch(final Map<String, String> parameters,
final Collection<String> expectedParameters) {
final Set<String> keySet = parameters.keySet();
- return (keySet.containsAll(expectedParameters) && expectedParameters.containsAll(keySet));
+ return (keySet.containsAll(expectedParameters) && expectedParameters
+ .containsAll(keySet));
}
-
+
private String variable(final String parameterName) {
return "${" + parameterName + "}";
}
-
+
/**
* @param parameters
* @param trim
* @return
*/
- private String substituteInto(final Map<String, String> parameters, final String text) {
+ private String substituteInto(final Map<String, String> parameters,
+ final String text) {
String result = text;
- for (Map.Entry<String, String> entry: parameters.entrySet()) {
+ for (final Map.Entry<String, String> entry : parameters.entrySet()) {
result = result.replace(variable(entry.getKey()), entry.getValue());
}
return result;
@@ -121,25 +129,25 @@ public class License implements Comparab
return this;
}
- /**
+ /**
* @return
*/
public String getId() {
- return id;
+ return this.id;
}
/**
* @return
*/
public String getURL() {
- return url;
+ return this.url;
}
/**
* @return
*/
public String getName() {
- return name;
+ return this.name;
}
/**
@@ -154,13 +162,16 @@ public class License implements Comparab
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
- public boolean equals(Object obj) {
- if (this == obj)
+ public boolean equals(final Object obj) {
+ if (this == obj) {
return true;
- if (obj == null)
+ }
+ if (obj == null) {
return false;
- if (getClass() != obj.getClass())
+ }
+ if (getClass() != obj.getClass()) {
return false;
+ }
final License other = (License) obj;
return getId().equals(other);
}
@@ -168,14 +179,15 @@ public class License implements Comparab
/**
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
- public int compareTo(License other) {
+ public int compareTo(final License other) {
final int nameDifference = getName().compareTo(other.getName());
- return nameDifference == 0 ? getId().compareTo(other.getId()) : nameDifference;
+ return nameDifference == 0 ? getId().compareTo(other.getId())
+ : nameDifference;
}
@Override
public String toString() {
- return "License [id=" + id + ", name=" + name + "]";
+ return "License [id=" + this.id + ", name=" + this.name + "]";
}
-
+
}
Modified: creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.java
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.java?rev=1340695&r1=1340694&r2=1340695&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.java (original)
+++ creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.java Sun May 20 12:30:38 2012
@@ -28,18 +28,19 @@ public class LicenseAndOrganisationColla
private final Set<License> licenses = new TreeSet<License>();
private final Set<Organisation> organisations = new TreeSet<Organisation>();
-
+
/**
* @return the licenses
*/
public Set<License> getLicenses() {
- return licenses;
+ return this.licenses;
}
+
/**
* @return the organisation
*/
public Set<Organisation> getOrganisation() {
- return organisations;
+ return this.organisations;
}
/**
@@ -49,39 +50,43 @@ public class LicenseAndOrganisationColla
public boolean traverseResource() {
return false;
}
-
+
/**
* @see org.apache.rat.whisker.legacy.out.Visitor#visit(org.apache.rat.whisker.legacy.out.WithLicense)
*/
@Override
- public void visit(WithLicense license) {
- licenses.add(license.getLicense());
+ public void visit(final WithLicense license) {
+ this.licenses.add(license.getLicense());
}
-
+
public boolean isOnlyLicense(final License license) {
- return (licenses.size() == 1) && licenses.contains(license);
+ return (this.licenses.size() == 1) && this.licenses.contains(license);
}
-
+
/**
* @see org.apache.rat.whisker.legacy.out.Visitor#visit(org.apache.rat.whisker.legacy.out.ByOrganisation)
*/
@Override
- public void visit(ByOrganisation byOrganisation) {
- organisations.add(byOrganisation.getOrganisation());
+ public void visit(final ByOrganisation byOrganisation) {
+ this.organisations.add(byOrganisation.getOrganisation());
}
+
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
- return "LicenseAndOrganisationCollator [licenses=" + licenses
- + ", organisations=" + organisations + "]";
+ return "LicenseAndOrganisationCollator [licenses=" + this.licenses
+ + ", organisations=" + this.organisations + "]";
}
+
/**
* @param primaryOrganisationId
* @return
*/
- public boolean isOnlyOrganisation(String primaryOrganisationId) {
- return organisations.size() == 1 && organisations.iterator().next().getId().equals(primaryOrganisationId);
+ public boolean isOnlyOrganisation(final String primaryOrganisationId) {
+ return this.organisations.size() == 1
+ && this.organisations.iterator().next().getId()
+ .equals(primaryOrganisationId);
}
}
Modified: creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/LicenseTemplateException.java
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/LicenseTemplateException.java?rev=1340695&r1=1340694&r2=1340695&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/LicenseTemplateException.java (original)
+++ creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/LicenseTemplateException.java Sun May 20 12:30:38 2012
@@ -32,63 +32,62 @@ public class LicenseTemplateException ex
* @param parameters
* @return
*/
- public static LicenseTemplateException notLicenseTemplate(Map<String, String> parameters, String name) {
- return new LicenseTemplateException("This is not a templated license", parameters, name);
+ public static LicenseTemplateException notLicenseTemplate(
+ final Map<String, String> parameters, final String name) {
+ return new LicenseTemplateException("This is not a templated license",
+ parameters, name);
}
-
/**
* @param string
* @param parameters
*/
- public LicenseTemplateException(String message,
- Map<String, String> parameters, String name) {
+ public LicenseTemplateException(final String message,
+ final Map<String, String> parameters, final String name) {
// TODO: improve reporting
super(message);
}
-
/**
* @param message
* @param expectedParameters
* @param actualParameters
*/
- public LicenseTemplateException(String message,
- Collection<String> expectedParameters,
- Collection<String> actualParameters) {
+ public LicenseTemplateException(final String message,
+ final Collection<String> expectedParameters,
+ final Collection<String> actualParameters) {
// TODO improve reporting
super(message);
}
-
/**
* @param string
* @param name
*/
- public LicenseTemplateException(String message, String name) {
+ public LicenseTemplateException(final String message, final String name) {
// TODO improve reporting
super(message);
}
-
/**
* @param expectedParameters
* @param keySet
* @return
*/
public static LicenseTemplateException parameterMismatch(
- Collection<String> expectedParameters, Collection<String> actualParameters) {
- return new LicenseTemplateException("Parameter mismatch.", expectedParameters, actualParameters);
+ final Collection<String> expectedParameters,
+ final Collection<String> actualParameters) {
+ return new LicenseTemplateException("Parameter mismatch.",
+ expectedParameters, actualParameters);
}
-
/**
* @param name
* @return
*/
- public static LicenseTemplateException duplicateParameterName(String name) {
+ public static LicenseTemplateException duplicateParameterName(
+ final String name) {
return new LicenseTemplateException("Duplicate parameter name.", name);
}
-
}
Modified: creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/NoticeCollator.java
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/NoticeCollator.java?rev=1340695&r1=1340694&r2=1340695&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/NoticeCollator.java (original)
+++ creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/NoticeCollator.java Sun May 20 12:30:38 2012
@@ -25,58 +25,62 @@ import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
-
/**
*
*/
public class NoticeCollator extends Visitor {
-
+
private final Map<String, Collection<Resource>> resourcesByNoticeId = new HashMap<String, Collection<Resource>>();
-
+
/**
* @return the noticeIds
*/
public Set<String> getNoticeIds() {
- return resourcesByNoticeId.keySet();
+ return this.resourcesByNoticeId.keySet();
}
/**
* @see org.apache.rat.whisker.legacy.out.Visitor#visit(org.apache.rat.whisker.legacy.out.Resource)
*/
@Override
- public void visit(Resource resource) {
+ public void visit(final Resource resource) {
final String noticeId = resource.getNoticeId();
if (noticeId != null) {
- if (!resourcesByNoticeId.containsKey(noticeId)) {
- resourcesByNoticeId.put(noticeId, new TreeSet<Resource>());
+ if (!this.resourcesByNoticeId.containsKey(noticeId)) {
+ this.resourcesByNoticeId.put(noticeId, new TreeSet<Resource>());
}
- resourcesByNoticeId.get(noticeId).add(resource);
+ this.resourcesByNoticeId.get(noticeId).add(resource);
}
}
- public Map<String, Collection<Resource>> resourceNotices(Map<String, String> notices) {
+ public Map<String, Collection<Resource>> resourceNotices(
+ final Map<String, String> notices) {
final Map<String, Collection<Resource>> results = new HashMap<String, Collection<Resource>>();
- for (Map.Entry<String, Collection<Resource>> entry: resourcesByNoticeId.entrySet()) {
+ for (final Map.Entry<String, Collection<Resource>> entry : this.resourcesByNoticeId
+ .entrySet()) {
if (notices.containsKey(entry.getKey())) {
- results.put(notices.get(entry.getKey()), new TreeSet<Resource>(entry.getValue()));
+ results.put(notices.get(entry.getKey()), new TreeSet<Resource>(
+ entry.getValue()));
} else {
- throw new IllegalArgumentException("Notice missing for id " + entry.getKey());
+ throw new IllegalArgumentException("Notice missing for id "
+ + entry.getKey());
}
}
return results;
}
-
+
/**
* @param notices
* @return
*/
- public Set<String> notices(Map<String, String> notices) {
+ public Set<String> notices(final Map<String, String> notices) {
final Set<String> results = new HashSet<String>();
- for (final String id: getNoticeIds()) {
+ for (final String id : getNoticeIds()) {
if (notices.containsKey(id)) {
results.add(notices.get(id));
} else {
- throw new IllegalArgumentException("Notice missing for id " + id);
+ throw new IllegalArgumentException("Notice missing for id "
+ + id);
}
}
return results;
Modified: creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Organisation.java
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Organisation.java?rev=1340695&r1=1340694&r2=1340695&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Organisation.java (original)
+++ creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Organisation.java Sun May 20 12:30:38 2012
@@ -28,8 +28,8 @@ public class Organisation implements Com
private final String id;
private final String name;
private final String url;
-
- public Organisation(String id, String name, String url) {
+
+ public Organisation(final String id, final String name, final String url) {
super();
this.id = id;
this.name = name;
@@ -39,62 +39,69 @@ public class Organisation implements Com
/**
* @param organisationsById
*/
- public Organisation storeIn(Map<String, Organisation> organisationsById) {
- organisationsById.put(id, this);
+ public Organisation storeIn(
+ final Map<String, Organisation> organisationsById) {
+ organisationsById.put(this.id, this);
return this;
}
-
+
public String getName() {
- return name;
+ return this.name;
}
public String getURL() {
- return url;
+ return this.url;
}
/**
* @return
*/
public String getId() {
- return id;
+ return this.id;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
- result = prime * result + ((id == null) ? 0 : id.hashCode());
+ result = prime * result + ((this.id == null) ? 0 : this.id.hashCode());
return result;
}
@Override
- public boolean equals(Object obj) {
- if (this == obj)
+ public boolean equals(final Object obj) {
+ if (this == obj) {
return true;
- if (obj == null)
+ }
+ if (obj == null) {
return false;
- if (getClass() != obj.getClass())
+ }
+ if (getClass() != obj.getClass()) {
return false;
- Organisation other = (Organisation) obj;
- if (id == null) {
- if (other.id != null)
+ }
+ final Organisation other = (Organisation) obj;
+ if (this.id == null) {
+ if (other.id != null) {
return false;
- } else if (!id.equals(other.id))
+ }
+ } else if (!this.id.equals(other.id)) {
return false;
+ }
return true;
}
/**
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
- public int compareTo(Organisation other) {
+ public int compareTo(final Organisation other) {
final int nameDifference = getName().compareTo(other.getName());
- return nameDifference == 0 ? getId().compareTo(other.getId()) : nameDifference;
+ return nameDifference == 0 ? getId().compareTo(other.getId())
+ : nameDifference;
}
@Override
public String toString() {
- return "Organisation [id=" + id + ", name=" + name + ", url=" + url
- + "]";
- }
+ return "Organisation [id=" + this.id + ", name=" + this.name + ", url="
+ + this.url + "]";
+ }
}
Modified: creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Resource.java
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Resource.java?rev=1340695&r1=1340694&r2=1340695&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Resource.java (original)
+++ creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Resource.java Sun May 20 12:30:38 2012
@@ -18,20 +18,20 @@
*/
package org.apache.creadur.whisker.model;
-
/**
*
*/
-public class Resource implements Comparable<Resource>{
+public class Resource implements Comparable<Resource> {
private final String name;
private final String noticeId;
private final String source;
-
+
/**
* @param name
*/
- public Resource(String name, final String noticeId, final String source) {
+ public Resource(final String name, final String noticeId,
+ final String source) {
super();
this.name = name;
this.noticeId = noticeId;
@@ -42,14 +42,14 @@ public class Resource implements Compara
* @return the name
*/
public String getName() {
- return name;
+ return this.name;
}
/**
* @return the noticeId
*/
public String getNoticeId() {
- return noticeId;
+ return this.noticeId;
}
/**
@@ -59,7 +59,8 @@ public class Resource implements Compara
public int hashCode() {
final int prime = 31;
int result = 1;
- result = prime * result + ((name == null) ? 0 : name.hashCode());
+ result = prime * result
+ + ((this.name == null) ? 0 : this.name.hashCode());
return result;
}
@@ -67,19 +68,24 @@ public class Resource implements Compara
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
- public boolean equals(Object obj) {
- if (this == obj)
+ public boolean equals(final Object obj) {
+ if (this == obj) {
return true;
- if (obj == null)
+ }
+ if (obj == null) {
return false;
- if (getClass() != obj.getClass())
+ }
+ if (getClass() != obj.getClass()) {
return false;
- Resource other = (Resource) obj;
- if (name == null) {
- if (other.name != null)
+ }
+ final Resource other = (Resource) obj;
+ if (this.name == null) {
+ if (other.name != null) {
return false;
- } else if (!name.equals(other.name))
+ }
+ } else if (!this.name.equals(other.name)) {
return false;
+ }
return true;
}
@@ -88,20 +94,20 @@ public class Resource implements Compara
*/
@Override
public String toString() {
- return "Resource [name=" + name + "]";
+ return "Resource [name=" + this.name + "]";
}
/**
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
- public int compareTo(Resource other) {
+ public int compareTo(final Resource other) {
return getName().compareTo(other.getName());
}
/**
* @param visitor
*/
- public void accept(Visitor visitor) {
+ public void accept(final Visitor visitor) {
if (visitor != null && visitor.traverseResource()) {
visitor.visit(this);
}
@@ -111,7 +117,7 @@ public class Resource implements Compara
* @return the source
*/
public String getSource() {
- return source;
+ return this.source;
}
/**
Modified: creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/ResourceNamesCollator.java
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/ResourceNamesCollator.java?rev=1340695&r1=1340694&r2=1340695&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/ResourceNamesCollator.java (original)
+++ creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/ResourceNamesCollator.java Sun May 20 12:30:38 2012
@@ -21,7 +21,6 @@ package org.apache.creadur.whisker.model
import java.util.Collection;
import java.util.TreeSet;
-
import org.apache.commons.lang3.tuple.ImmutablePair;
import org.apache.commons.lang3.tuple.Pair;
@@ -29,17 +28,17 @@ import org.apache.commons.lang3.tuple.Pa
*
*/
public class ResourceNamesCollator extends Visitor {
-
+
private final Collection<Pair<WithinDirectory, Resource>> resources = new TreeSet<Pair<WithinDirectory, Resource>>();
private final Collection<Pair<WithinDirectory, Resource>> duplicates = new TreeSet<Pair<WithinDirectory, Resource>>();
- private WithinDirectory lastDirectory;
+ private WithinDirectory lastDirectory;
/**
* @return the names
*/
public Collection<String> getNames() {
final Collection<String> names = new TreeSet<String>();
- for (Pair<WithinDirectory, Resource> pair: resources) {
+ for (final Pair<WithinDirectory, Resource> pair : this.resources) {
names.add(pair.getRight().getName());
}
return names;
@@ -49,16 +48,14 @@ public class ResourceNamesCollator exten
* @return the duplicates
*/
public Collection<Pair<WithinDirectory, Resource>> getDuplicates() {
- return duplicates;
+ return this.duplicates;
}
-
-
/**
* @see org.apache.rat.whisker.legacy.out.Visitor#visit(org.apache.rat.whisker.legacy.out.WithinDirectory)
*/
@Override
- public void visit(WithinDirectory directory) {
+ public void visit(final WithinDirectory directory) {
this.lastDirectory = directory;
}
@@ -66,16 +63,19 @@ public class ResourceNamesCollator exten
* @see org.apache.rat.whisker.legacy.out.Visitor#visit(org.apache.rat.whisker.legacy.out.Resource)
*/
@Override
- public void visit(Resource resource) {
- if (resources.add(new ImmutablePair<WithinDirectory, Resource>(lastDirectory, resource))) {
+ public void visit(final Resource resource) {
+ if (this.resources.add(new ImmutablePair<WithinDirectory, Resource>(
+ this.lastDirectory, resource))) {
// Fine
} else {
// Already added
- if (lastDirectory == null) {
+ if (this.lastDirectory == null) {
// Issue with logic which will result in a null pointer later
- throw new IllegalArgumentException("Expected directory to be present");
+ throw new IllegalArgumentException(
+ "Expected directory to be present");
}
- duplicates.add(new ImmutablePair<WithinDirectory, Resource>(lastDirectory, resource));
+ this.duplicates.add(new ImmutablePair<WithinDirectory, Resource>(
+ this.lastDirectory, resource));
}
}
}
Modified: creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Visitor.java
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Visitor.java?rev=1340695&r1=1340694&r2=1340695&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Visitor.java (original)
+++ creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/Visitor.java Sun May 20 12:30:38 2012
@@ -27,22 +27,29 @@ public abstract class Visitor {
public boolean traversePublicDomain() {
return true;
}
-
+
public boolean traverseWithLicense() {
return true;
}
-
+
public boolean traverseByOrganisation() {
return true;
}
-
+
public boolean traverseResource() {
return true;
}
// Classic visitor pattern
- public void visit(final WithinDirectory directory) {};
- public void visit(final WithLicense license) {};
- public void visit(final ByOrganisation byOrganisation) {};
- public void visit(final Resource resource) {};
+ public void visit(final WithinDirectory directory) {
+ };
+
+ public void visit(final WithLicense license) {
+ };
+
+ public void visit(final ByOrganisation byOrganisation) {
+ };
+
+ public void visit(final Resource resource) {
+ };
}
Modified: creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/WithLicense.java
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/WithLicense.java?rev=1340695&r1=1340694&r2=1340695&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/WithLicense.java (original)
+++ creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/WithLicense.java Sun May 20 12:30:38 2012
@@ -22,23 +22,21 @@ import java.util.Collection;
import java.util.Collections;
import java.util.Map;
-
/**
*
*/
public class WithLicense implements Comparable<WithLicense> {
-
-
+
private final License license;
private final Collection<ByOrganisation> organisations;
private final String copyrightNotice;
private final Map<String, String> parameters;
- /**
+
+ /**
* @param license
* @param element
*/
- public WithLicense(License license,
- final String copyrightNotice,
+ public WithLicense(final License license, final String copyrightNotice,
final Map<String, String> parameters,
final Collection<ByOrganisation> organisations) {
super();
@@ -49,57 +47,57 @@ public class WithLicense implements Comp
}
public String getCopyrightNotice() {
- return copyrightNotice;
+ return this.copyrightNotice;
}
-
+
public String getName() {
- return license.getName();
+ return this.license.getName();
}
-
+
public String getURL() {
- return license.getURL();
+ return this.license.getURL();
}
-
+
public License getLicense() {
- return license;
+ return this.license;
}
-
+
public String getText() throws LicenseTemplateException {
- return license.getText(parameters);
+ return this.license.getText(this.parameters);
}
-
+
public Collection<ByOrganisation> getOrganisations() {
- return organisations;
+ return this.organisations;
}
public Map<String, String> getParameters() {
- return parameters;
+ return this.parameters;
}
/**
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
- public int compareTo(WithLicense other) {
- return license.compareTo(other.getLicense());
+ public int compareTo(final WithLicense other) {
+ return this.license.compareTo(other.getLicense());
}
-
/**
* @param visitor
*/
- public void accept(Visitor visitor) {
+ public void accept(final Visitor visitor) {
if (visitor != null && visitor.traverseWithLicense()) {
visitor.visit(this);
- for (final ByOrganisation organisation: getOrganisations()) {
+ for (final ByOrganisation organisation : getOrganisations()) {
organisation.accept(visitor);
}
}
}
+
/**
* @return
*/
public boolean isSourceRequired() {
- return license.isSourceRequired();
+ return this.license.isSourceRequired();
}
-
+
}
Modified: creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/WithinDirectory.java
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/WithinDirectory.java?rev=1340695&r1=1340694&r2=1340695&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/WithinDirectory.java (original)
+++ creadur/whisker/trunk/apache-whisker-model/src/main/java/org/apache/creadur/whisker/model/WithinDirectory.java Sun May 20 12:30:38 2012
@@ -20,41 +20,40 @@ package org.apache.creadur.whisker.model
import java.util.Collection;
-
/**
*
*/
public class WithinDirectory implements Comparable<WithinDirectory> {
-
private final Collection<WithLicense> licenses;
private final Collection<ByOrganisation> publicDomain;
private final String name;
-
+
/**
* @param element
*/
- public WithinDirectory(final String name, final Collection<WithLicense> licenses,
- Collection<ByOrganisation> publicDomain) {
+ public WithinDirectory(final String name,
+ final Collection<WithLicense> licenses,
+ final Collection<ByOrganisation> publicDomain) {
super();
this.name = name;
this.licenses = licenses;
this.publicDomain = publicDomain;
}
-
+
/**
* @return the publicDomain
*/
public Collection<ByOrganisation> getPublicDomain() {
- return publicDomain;
+ return this.publicDomain;
}
public String getName() {
- return name;
+ return this.name;
}
-
+
public Collection<WithLicense> getLicenses() {
- return licenses;
+ return this.licenses;
}
/**
@@ -69,13 +68,16 @@ public class WithinDirectory implements
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
- public boolean equals(Object obj) {
- if (this == obj)
+ public boolean equals(final Object obj) {
+ if (this == obj) {
return true;
- if (obj == null)
+ }
+ if (obj == null) {
return false;
- if (getClass() != obj.getClass())
+ }
+ if (getClass() != obj.getClass()) {
return false;
+ }
final WithinDirectory other = (WithinDirectory) obj;
return getName().equals(other.getName());
}
@@ -83,37 +85,34 @@ public class WithinDirectory implements
/**
* @see java.lang.Comparable#compareTo(java.lang.Object)
*/
- public int compareTo(WithinDirectory other) {
+ public int compareTo(final WithinDirectory other) {
return getName().compareTo(other.getName());
}
-
/**
* @param directoryName
* @return
*/
- public boolean isNamed(String directoryName) {
+ public boolean isNamed(final String directoryName) {
return getName().equals(directoryName);
}
-
/**
* @param visitor
*/
- public void accept(Visitor visitor) {
- if (visitor != null) {
+ public void accept(final Visitor visitor) {
+ if (visitor != null) {
visitor.visit(this);
if (visitor.traversePublicDomain()) {
- for (final ByOrganisation organisation: getPublicDomain()) {
+ for (final ByOrganisation organisation : getPublicDomain()) {
organisation.accept(visitor);
- }
+ }
}
-
- for (final WithLicense license: getLicenses()) {
+
+ for (final WithLicense license : getLicenses()) {
license.accept(visitor);
}
}
}
-
-
+
}