add some Javadocs and fix Licence.txt space

Former-commit-id: bb2eb55
fujaba · Aug 29, 2014 · e5e6f59 · e5e6f59
1 parent 35e62e9
commit e5e6f59
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 13 deletions.
diff --git a/check.xml b/check.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<project default="findBugs" name="Create Jar for NetworkParser" xmlns:cs="antlib:com.puppycrawl.tools.checkstyle">
+<project default="checkStyle" name="Create Jar for NetworkParser" xmlns:cs="antlib:com.puppycrawl.tools.checkstyle">
 	<target name="checkStyle">
 		<taskdef resource="checkstyletask.properties" classpath="lib/checkstyle-5.7/checkstyle-5.7-all.jar" />
 		<checkstyle config="lib/checkstyle-5.7/sun_checks.xml" >
-			<fileset dir="src/" includes="**/*.java"/>
+			<fileset dir="src/main/java" includes="**/*.java"/>
 			<!-- Location of cache-file. Something that is project specific -->
 			<property key="checkstyle.cache.file" file="target/cachefile"/>
 			<property key="LineLength.max" value="200"></property>

diff --git a/src/Ant/de/uniks/networkparser/test/build/Licence.txt b/src/Ant/de/uniks/networkparser/test/build/Licence.txt
@@ -2,7 +2,7 @@
  NetworkParser
  Copyright (c) 2011 - 2013, Stefan Lindel
  All rights reserved.
- 
+
  Licensed under the EUPL, Version 1.1 or (as soon they
  will be approved by the European Commission) subsequent
  versions of the EUPL (the "Licence");

diff --git a/src/main/java/de/uniks/networkparser/AbstractEntity.java b/src/main/java/de/uniks/networkparser/AbstractEntity.java
@@ -11,7 +11,7 @@
  NetworkParser
  Copyright (c) 2011 - 2013, Stefan Lindel
  All rights reserved.
- 
+
  Licensed under the EUPL, Version 1.1 or (as soon they
  will be approved by the European Commission) subsequent
  versions of the EUPL (the "Licence");
@@ -29,6 +29,14 @@
  permissions and limitations under the Licence.
 */
 
+/**
+ * AbstractEntity is a Simple KeyValue - Object.
+ *
+ * @author Stefan Lindel
+ *
+ * @param <K> Key Element 
+ * @param <V> Value Element
+ */
 public abstract class AbstractEntity<K, V> implements BaseItem, Entry<K, V>, SendableEntityCreator, SendableEntityCreatorNoIndex {
 	public static final String PROPERTY_KEY = "key";
 	public static final String PROPERTY_VALUE = "value";
@@ -181,4 +189,4 @@ public boolean setValue(Object entity, String attribute, Object value,
 		}
 		return false;
 	}
-}
+}
diff --git a/src/main/java/de/uniks/networkparser/AbstractList.java b/src/main/java/de/uniks/networkparser/AbstractList.java
@@ -493,15 +493,10 @@ public boolean isAllowDuplicate() {
 		return allowDuplicate;
 	}
 
-	/**
-	 * Set the Flag for Duplicate Entities
-	 * @param allowDuplicate isAllowDuplicate
-	 * @return the List
-	 */
 	@SuppressWarnings("unchecked")
 	public <ST extends AbstractList<V>> ST withAllowDuplicate(boolean allowDuplicate) {
 		this.allowDuplicate = allowDuplicate;
-		return (ST)this;
+		return (ST) this;
 	}
 
 	/**
@@ -693,6 +688,7 @@ public int getPositionKey(Object o)
     /**
      * Get the HashKey from a Object with Max HashTableIndex and StepSize of EntitySize
      * @param hashKey the hashKey of a Object
+     * @param len the max Length of all Hashvalues
      * @return the hasKey
      */
     public int hashKey(int hashKey, int len)

diff --git a/src/main/java/de/uniks/networkparser/xml/XMLEntity.java b/src/main/java/de/uniks/networkparser/xml/XMLEntity.java
@@ -165,7 +165,7 @@ public String getValueItem() {
 	 * 
 	 * @param value
 	 *            the new value
-	 * @return 
+	 * @return the XMLEntity Instance
 	 */
 	public XMLEntity withValueItem(String value) {
 		this.value = value;

diff --git a/src/test/java/de/uniks/networkparser/test/ColumnTest.java b/src/test/java/de/uniks/networkparser/test/ColumnTest.java
@@ -7,6 +7,7 @@
 import de.uniks.networkparser.gui.table.Column;
 import de.uniks.networkparser.gui.table.ColumnListener;
 import de.uniks.networkparser.gui.table.util.ColumnCreator;
+import de.uniks.networkparser.interfaces.GUIPosition;
 import de.uniks.networkparser.interfaces.SendableEntityCreator;
 import de.uniks.networkparser.json.JsonIdMap;
 
@@ -22,7 +23,11 @@ public void testColumn(){
 
 	@Test
 	public void testColumnSerialization(){
-		Column column=new Column().withAttrName("Name");
+		Column column=new Column().withAttrName("Name").withResizable(true);
+		column.withVisible(true);
+		column.withMovable(true);
+		Assert.assertEquals(column.getBrowserId(), GUIPosition.CENTER);
+
 		JsonIdMap map=(JsonIdMap) new JsonIdMap().withCreator(new ColumnCreator());
 
 		Assert.assertEquals("{\"class\":\"de.uniks.networkparser.gui.table.Column\",\"id\":\"J1.C1\",\"prop\":{\"attrName\":\"Name\"}}", map.toJsonObject(column).toString());