From 918ba05b00427b7a782f9399e6d0296fe4f67d3c Mon Sep 17 00:00:00 2001 From: helllth
Note that if this is false
, openURL()
will always return an IOException.
String
astring(value) to a Integery
id(key).
*
- * @param id DOCUMENT ME!
- * @param aString DOCUMENT ME!
+ * @param id key
+ * @param aString value
+ *
+ * @see #put(java.lang.Object, java.lang.Object)
*/
public void add(final int id, final String aString) {
super.put(new Integer(id), aString);
} // end add
/**
- * DOCUMENT ME!
+ * Getter for the Value as a String
*
- * @param id DOCUMENT ME!
+ * @param id key
*
- * @return DOCUMENT ME!
+ * @return Stringvalue
*
- * @throws Exception DOCUMENT ME!
- * @throws java.lang.NullPointerException DOCUMENT ME!
+ * @throws Exception throws Exeption if anything went wrong
+ * @throws java.lang.NullPointerException "Entry is not a String" if key not a String or "No entry" if
+ * id<\code> has no entry
*/
public String getStringValue(final int id) throws Exception {
final Integer key = new Integer(id);
@@ -72,11 +75,13 @@ public String getStringValue(final int id) throws Exception {
// when exception concept is accomplished
}
/**
- * ///// containsIntKey/////////////////////////////////
+ * Tests if the specified object is a key in IntMapsString
*
- * @param key DOCUMENT ME!
+ * @param key possible key
*
- * @return DOCUMENT ME!
+ * @return true
, if the object is a key in IntMapsString
+ *
+ * @see #containsKey(java.lang.Object)
*/
public boolean containsIntKey(final int key) {
return super.containsKey(new Integer(key));
diff --git a/src/main/java/Sirius/util/collections/MultiMap.java b/src/main/java/Sirius/util/collections/MultiMap.java
index 93f69cb..98367dc 100644
--- a/src/main/java/Sirius/util/collections/MultiMap.java
+++ b/src/main/java/Sirius/util/collections/MultiMap.java
@@ -18,15 +18,15 @@ public class MultiMap extends HashMap {
//~ Constructors -----------------------------------------------------------
/**
- * //////////////////////////////////////////////
+ * Creates new Multimap Object with size 10.
*/
public MultiMap() {
this(10);
}
/**
- * //////////////////////////////////////////////
+ * Creates new Multimap Object with chosen size.
*
- * @param size DOCUMENT ME!
+ * @param size size
*/
public MultiMap(final int size) {
super(size);
@@ -35,7 +35,17 @@ public MultiMap(final int size) {
//~ Methods ----------------------------------------------------------------
/////////////////////////////////////////////////
-
+
+ /**
+ * Assosiates value
with key
in this map
.
+ * Instead of replace the values for a key, are multiple values for one key possible.
+ *
+ * @param key key
+ * @param value value
+ *
+ * @return Null
+ */
+
@Override
public Object put(final Object key, final Object value) {
SyncLinkedList list = null;
@@ -59,6 +69,14 @@ public Object put(final Object key, final Object value) {
} // end add
//////////////////////////////////////////////////////////////
+ /**
+ * Appends the values of the specified map
to this map
.
+ * Instead of replace the values for a key, are multiple values for one key possible.
+ *
+ *
+ *
+ * @param t map
+ */
@Override
public void putAll(final Map t) {
@@ -84,12 +102,12 @@ public void putAll(final Map t) {
}
/**
- * //////////////////////////////////////////////////////
+ * removes specied value
associeated with specified key
*
- * @param key DOCUMENT ME!
- * @param value DOCUMENT ME!
+ * @param key key whose mapping is to be removed
+ * @param value mapping to be removed
*
- * @return DOCUMENT ME!
+ * @return true, if remove suceeded
*/
public boolean remove(final Object key, final Object value) {
SyncLinkedList list = null;
diff --git a/src/main/java/Sirius/util/collections/StringMapsInt.java b/src/main/java/Sirius/util/collections/StringMapsInt.java
index f47c7f6..4f60b9e 100644
--- a/src/main/java/Sirius/util/collections/StringMapsInt.java
+++ b/src/main/java/Sirius/util/collections/StringMapsInt.java
@@ -26,8 +26,8 @@ public StringMapsInt() {
/**
* Creates a new StringMapsInt object.
*
- * @param initialCapacity DOCUMENT ME!
- * @param loadFactor DOCUMENT ME!
+ * @param initialCapacity Capacity when Object is created
+ * @param loadFactor buffer for capacity increase
*/
public StringMapsInt(final int initialCapacity, final float loadFactor) {
super(initialCapacity, loadFactor);
@@ -36,24 +36,26 @@ public StringMapsInt(final int initialCapacity, final float loadFactor) {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * Associates Integer
sq1ID(value
) to a String
descriptor(key
).
*
- * @param descriptor DOCUMENT ME!
- * @param sqlID DOCUMENT ME!
+ * @param descriptor key
+ * @param sqlID value
+ *
+ * @see #put(java.lang.Object, java.lang.Object)
*/
public void add(final String descriptor, final int sqlID) {
super.put(descriptor, new Integer(sqlID));
} // end add
/**
- * /////////////////////////////////////////
+ * Getter for the Value as a Integer
*
- * @param descriptor DOCUMENT ME!
+ * @param descriptor descriptor
*
- * @return DOCUMENT ME!
+ * @return IntValue
*
* @throws Exception DOCUMENT ME!
- * @throws java.lang.NullPointerException DOCUMENT ME!
+ * @throws java.lang.NullPointerException "Entry is not a Integer" or "No entry"
*/
public int getIntValue(final String descriptor) throws Exception {
if (super.containsKey(descriptor)) {
@@ -71,11 +73,13 @@ public int getIntValue(final String descriptor) throws Exception {
// accomplished
}
/**
- * ///// containsIntKey/////////////////////////////////
+ * Tests if the specified object is a key in StringMapsInt
*
- * @param key DOCUMENT ME!
+ * @param key possible key
*
- * @return DOCUMENT ME!
+ * @return true
, if the object is a key in StringMapsInt
+ *
+ * @see #containsKey(java.lang.Object)
*/
public boolean containsStringKey(final String key) {
return super.containsKey(key);
diff --git a/src/main/java/Sirius/util/collections/StringMapsString.java b/src/main/java/Sirius/util/collections/StringMapsString.java
index 1f10865..cef61cb 100644
--- a/src/main/java/Sirius/util/collections/StringMapsString.java
+++ b/src/main/java/Sirius/util/collections/StringMapsString.java
@@ -17,7 +17,7 @@ public class StringMapsString extends java.util.Hashtable {
//~ Constructors -----------------------------------------------------------
/**
- * ---------------------------------------------------------
+ * Creates a new StringMapString object
*/
public StringMapsString() {
super();
@@ -26,17 +26,17 @@ public StringMapsString() {
/**
* Creates a new StringMapsString object.
*
- * @param initialCapacity DOCUMENT ME!
+ * @param initialCapacity Capacity when Object is created
*/
public StringMapsString(final int initialCapacity) {
super(initialCapacity);
}
/**
- * ---------------------------------------------------------
+ * Creates a new StringMapsString object.
*
- * @param initialCapacity DOCUMENT ME!
- * @param loadFactor DOCUMENT ME!
+ * @param initialCapacity Capacity when Object is created
+ * @param loadFactor buffer for capacity increase
*/
public StringMapsString(final int initialCapacity, final float loadFactor) {
super(initialCapacity, loadFactor);
@@ -45,12 +45,12 @@ public StringMapsString(final int initialCapacity, final float loadFactor) {
//~ Methods ----------------------------------------------------------------
/**
- * -----------------------------------------------------------
+ * Associates a String
astring(value) to a String
descriptor(key).
*
- * @param descriptor DOCUMENT ME!
- * @param aString DOCUMENT ME!
+ * @param descriptor key
+ * @param aString value
*
- * @throws Exception DOCUMENT ME!
+ * @throws Exception Contains no Key
*/
public void add(final String descriptor, final String aString) throws Exception {
super.put(descriptor, aString);
@@ -61,14 +61,14 @@ public void add(final String descriptor, final String aString) throws Exception
} // end add
/**
- * ---------------------------------------------------------
+ * Getter for the Value as a String
*
- * @param descriptor DOCUMENT ME!
+ * @param descriptor key
*
- * @return DOCUMENT ME!
+ * @return StringValue
*
- * @throws Exception DOCUMENT ME!
- * @throws java.lang.NullPointerException DOCUMENT ME!
+ * @throws Exception
+ * @throws java.lang.NullPointerException "Entry is no String" or "No Entry"
*/
public String getStringValue(final String descriptor) throws Exception {
if (containsKey(descriptor)) {
@@ -84,11 +84,13 @@ public String getStringValue(final String descriptor) throws Exception {
throw new java.lang.NullPointerException("No entry :" + descriptor); // NOI18N
}
/**
- * ///// containsIntKey/////////////////////////////////
+ * Tests if the specified object is a key in StringMapsString
*
- * @param key DOCUMENT ME!
+ * @param key possible key
*
- * @return DOCUMENT ME!
+ * @return true
, if the object is a key in StringMapsString
+ *
+ * @see #containsKey(java.lang.Object)
*/
public boolean containsStringKey(final String key) {
return super.containsKey(key);
From 1c14a4c6991dcc9b81d15af5e0cef246a61231e6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?= Geometry
*
- * @return DOCUMENT ME!
+ * @return String
"SRID= SRID
;Text"
*/
public static String getPostGisCompliantDbString(final Geometry g) {
if (g == null) {
@@ -52,24 +52,24 @@ public static String getPostGisCompliantDbString(final Geometry g) {
}
/**
- * DOCUMENT ME!
+ * Creates new JtsPoint
by using point
*
- * @param point DOCUMENT ME!
- * @param geometryFactory DOCUMENT ME!
+ * @param point point
+ * @param geometryFactory geometryFactory
*
- * @return DOCUMENT ME!
+ * @return point
*/
private static Point createJtsPoint(final org.postgis.Point point, final GeometryFactory geometryFactory) {
return geometryFactory.createPoint(new Coordinate(point.getX(), point.getY()));
}
/**
- * DOCUMENT ME!
+ * Creates new JtsLineString
by using lineString
*
- * @param lineString DOCUMENT ME!
- * @param geometryFactory DOCUMENT ME!
+ * @param lineString lineString
+ * @param geometryFactory geometryFactory
*
- * @return DOCUMENT ME!
+ * @return LineString
*/
private static LineString createJtsLineString(final org.postgis.LineString lineString,
final GeometryFactory geometryFactory) {
@@ -81,12 +81,12 @@ private static LineString createJtsLineString(final org.postgis.LineString lineS
}
/**
- * DOCUMENT ME!
+ * Creates new JtsLinearRing
by using linearRing
*
- * @param linearRing DOCUMENT ME!
- * @param geometryFactory DOCUMENT ME!
+ * @param linearRing linearRing
+ * @param geometryFactory geometryFactory
*
- * @return DOCUMENT ME!
+ * @return linearRing
*/
private static LinearRing createJtsLinearRing(final org.postgis.LinearRing linearRing,
final GeometryFactory geometryFactory) {
@@ -103,12 +103,14 @@ private static LinearRing createJtsLinearRing(final org.postgis.LinearRing linea
}
/**
- * DOCUMENT ME!
+ * Creates new JtsPolygon
by using polygon
*
- * @param polygon DOCUMENT ME!
- * @param geometryFactory DOCUMENT ME!
+ * @param polygon polygon
+ * @param geometryFactory geometryFactory
*
- * @return DOCUMENT ME!
+ * @return polygon
+ *
+ * @see #createJtsLinearRing(org.postgis.LinearRing, com.vividsolutions.jts.geom.GeometryFactory)
*/
private static Polygon createJtsPolygon(final org.postgis.Polygon polygon, final GeometryFactory geometryFactory) {
final int ringcount = polygon.numRings();
@@ -128,12 +130,14 @@ private static Polygon createJtsPolygon(final org.postgis.Polygon polygon, final
}
/**
- * DOCUMENT ME!
+ * Creates new JtsMultiPoint
by using MultiPoint
*
- * @param multiPoint DOCUMENT ME!
- * @param geometryFactory DOCUMENT ME!
+ * @param multiPoint MultiPoint
+ * @param geometryFactory geometryFactory
*
- * @return DOCUMENT ME!
+ * @return MultiPoint
+ *
+ * @see #createJtsPoint(org.postgis.Point, com.vividsolutions.jts.geom.GeometryFactory)
*/
private static MultiPoint createJtsMultiPoint(final org.postgis.MultiPoint multiPoint,
final GeometryFactory geometryFactory) {
@@ -151,12 +155,14 @@ private static MultiPoint createJtsMultiPoint(final org.postgis.MultiPoint multi
}
/**
- * DOCUMENT ME!
+ * Creates new JtsMultiLineString
by using MultiLineString
*
- * @param multiLineString DOCUMENT ME!
- * @param geometryFactory DOCUMENT ME!
+ * @param multiLineString MultiLineString
+ * @param geometryFactory geometryFactory
*
- * @return DOCUMENT ME!
+ * @return MultiLineString
+ *
+ * @see #createJtsLineString(org.postgis.LineString, com.vividsolutions.jts.geom.GeometryFactory)
*/
private static MultiLineString createJtsMultiLineString(final org.postgis.MultiLineString multiLineString,
final GeometryFactory geometryFactory) {
@@ -174,12 +180,14 @@ private static MultiLineString createJtsMultiLineString(final org.postgis.MultiL
}
/**
- * DOCUMENT ME!
+ * Creates new JtsMultiPolygon
by using MultiPolygon
*
- * @param multiPolygon DOCUMENT ME!
- * @param geometryFactory DOCUMENT ME!
+ * @param multiPolygon MultiPolygon
!
+ * @param geometryFactory geometryFactory
*
- * @return DOCUMENT ME!
+ * @return MultiPolygon
+ *
+ * @see #createJtsPolygon(org.postgis.Polygon, com.vividsolutions.jts.geom.GeometryFactory)
*/
private static MultiPolygon createJtsMultiPolygon(final org.postgis.MultiPolygon multiPolygon,
final GeometryFactory geometryFactory) {
@@ -197,12 +205,12 @@ private static MultiPolygon createJtsMultiPolygon(final org.postgis.MultiPolygon
}
/**
- * DOCUMENT ME!
+ * Creates new JtsGeometryCollection
by using GeometryCollection
*
- * @param geometryCollection DOCUMENT ME!
- * @param geometryFactory DOCUMENT ME!
+ * @param geometryCollection GeometryCollection
+ * @param geometryFactory geometryFactory
*
- * @return DOCUMENT ME!
+ * @return GeometryCollection
*/
private static GeometryCollection createJtsGeometryCollection(
final org.postgis.GeometryCollection geometryCollection,
@@ -256,11 +264,11 @@ private static GeometryCollection createJtsGeometryCollection(
}
/**
- * DOCUMENT ME!
+ * Creates new JtsGeometry
by using Geometry
*
- * @param geom DOCUMENT ME!
+ * @param geom Geometry
*
- * @return DOCUMENT ME!
+ * @return Geometry
*/
public static Geometry createJtsGeometry(final org.postgis.Geometry geom) {
final GeometryFactory geometryFactory = new GeometryFactory(new PrecisionModel(PrecisionModel.FLOATING),
From 30e3ae1968aa1c063ce2b343c120673e347d517b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?= host
*
- * @return DOCUMENT ME!
+ * @return host
*/
public String getHost() {
return host;
}
/**
- * DOCUMENT ME!
+ * Setter for host
*
- * @param host DOCUMENT ME!
+ * @param host host
*/
public void setHost(final String host) {
this.host = ((host == null) || host.isEmpty()) ? null : host;
}
/**
- * DOCUMENT ME!
+ * Getter for port
*
- * @return DOCUMENT ME!
+ * @return port
*/
public int getPort() {
return port;
}
/**
- * DOCUMENT ME!
+ * Setter for port
*
- * @param port DOCUMENT ME!
+ * @param port port
*/
public void setPort(final int port) {
this.port = port;
}
+ /**
+ * return as String
+ *
+ * @return "Proxy: " + host
+ ":" + port
+ " | username: " + username
+
+ " | password: " + ((password
== null
) ? null
: "domain
+ */
@Override
public String toString() {
return "Proxy: " + host + ":" + port + " | username: " + username + " | password: " // NOI18N
@@ -152,86 +158,88 @@ public String toString() {
}
/**
- * DOCUMENT ME!
+ * Getter for domain
*
- * @return DOCUMENT ME!
+ * @return domain
*/
public String getDomain() {
return domain;
}
/**
- * DOCUMENT ME!
+ * Setter for domain
*
- * @param domain DOCUMENT ME!
+ * @param domain domain
*/
public void setDomain(final String domain) {
this.domain = ((domain == null) || domain.isEmpty()) ? null : domain;
}
/**
- * DOCUMENT ME!
+ * Getter for password
*
- * @return DOCUMENT ME!
+ * @return password
*/
public String getPassword() {
return password;
}
/**
- * DOCUMENT ME!
+ * Setter for password
*
- * @param password DOCUMENT ME!
+ * @param password password
*/
public void setPassword(final String password) {
this.password = ((password == null) || password.isEmpty()) ? null : password;
}
/**
- * DOCUMENT ME!
+ * Getter for username
*
- * @return DOCUMENT ME!
+ * @return username
*/
public String getUsername() {
return username;
}
/**
- * DOCUMENT ME!
+ * Setter for username
*
- * @param username DOCUMENT ME!
+ * @param username username
*/
public void setUsername(final String username) {
this.username = ((username == null) || username.isEmpty()) ? null : username;
}
/**
- * DOCUMENT ME!
+ * Tests whether enabled
is true or false
*
- * @return DOCUMENT ME!
+ * @return true, if it is enabled
*/
public boolean isEnabled() {
return enabled;
}
/**
- * DOCUMENT ME!
+ * Enables or disables
*
- * @param enabled DOCUMENT ME!
+ * @param enabled true
or false
*/
public void setEnabled(final boolean enabled) {
this.enabled = enabled;
}
/**
- * DOCUMENT ME!
+ * Stores this proxy in the user's preferences.
+ *
+ * @see #toPreferences(de.cismet.netutil.Proxy)
*/
public void toPreferences() {
toPreferences(this);
}
/**
- * DOCUMENT ME!
+ * Clears the Proxy Object
*/
public static void clear() {
final Preferences prefs = Preferences.userNodeForPackage(Proxy.class);
@@ -307,9 +315,11 @@ public static void toPreferences(final Proxy proxy) {
}
/**
- * DOCUMENT ME!
+ * Loads a Proxy
instance from System preferences. If there are no host and port proxy
+ * information null
will be returned. If the return value is non-null at least the host and the port is
+ * initialised. Username, Password and Domain may be null.
*
- * @return DOCUMENT ME!
+ * @return the user's proxy settings or null if no settings present
*/
public static Proxy fromSystem() {
if (Boolean.getBoolean(System.getProperty(SYSTEM_PROXY_SET))) {
@@ -333,9 +343,9 @@ public static Proxy fromSystem() {
}
/**
- * DOCUMENT ME!
+ * main
*
- * @param args DOCUMENT ME!
+ * @param args args
*/
// NOTE: use cli library if there shall be more (complex) options
@SuppressWarnings("CallToThreadDumpStack")
@@ -374,10 +384,11 @@ public static void main(final String[] args) {
}
/**
- * DOCUMENT ME!
+ * shows Message.
+ * If there is no System.console it writes the meassage on OptionPane.Else it writes the message on Console as Error or Output.
*
- * @param message DOCUMENT ME!
- * @param error DOCUMENT ME!
+ * @param message the message
+ * @param error true if it is a error message,false if not
*/
private static void showMessage(final String message, final boolean error) {
if (System.console() == null) {
@@ -396,7 +407,7 @@ private static void showMessage(final String message, final boolean error) {
}
/**
- * DOCUMENT ME!
+ * print usage
*/
private static void printUsage() {
showMessage("Supported parameters are:\n\n" // NOI18N
From ed78119eb93ce4b8bb87dde21852393f6e742e4a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?= targetExpressions
*
- * @return DOCUMENT ME!
+ * @return targetExpressions
*/
public String[] getTargetExpressions() {
return targetExpressions;
}
/**
- * DOCUMENT ME!
+ * Setter for targetExpressions
*
- * @param targetExpressions DOCUMENT ME!
+ * @param targetExpressions targetExpressions
*/
public void setTargetExpressions(final String[] targetExpressions) {
this.targetExpressions = targetExpressions;
}
/**
- * DOCUMENT ME!
+ * Getter for targetGroupkey
*
- * @return DOCUMENT ME!
+ * @return targetGroupkey
*/
public String getTargetGroupkey() {
return targetGroupkey;
}
/**
- * DOCUMENT ME!
+ * Setter for targetGroupkey
*
- * @param targetGroupkey DOCUMENT ME!
+ * @param targetGroupkey targetGroupkey
*/
public void setTargetGroupkey(final String targetGroupkey) {
this.targetGroupkey = targetGroupkey;
}
/**
- * DOCUMENT ME!
+ * Tests whether the String
matches or not
*
- * @param candidate DOCUMENT ME!
+ * @param candidate given String
*
- * @return DOCUMENT ME!
+ * @return true
if it matches
*/
public boolean matches(final String candidate) {
for (final String regex : targetExpressions) {
From 096160731062841f8b53adca0406b97b99dd22ab Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?= port
+ */
@Override
public int getPort() {
return this.port;
}
+ /**
+ * Getter for Path
+ *
+ * @return path
+ */
@Override
public String getPath() {
return this.path;
}
+ /**
+ * return as String
+ *
+ * @return Class
+ name
+ " path: " + path
+ " port: " + port
+ */
@Override
public String toString() {
return this.getClass().getName() + " path: " + this.path + " port: " + this.port;
diff --git a/src/main/java/de/cismet/remote/RESTRemoteControlMethodRegistry.java b/src/main/java/de/cismet/remote/RESTRemoteControlMethodRegistry.java
index 9cb6e8c..48ebf3a 100644
--- a/src/main/java/de/cismet/remote/RESTRemoteControlMethodRegistry.java
+++ b/src/main/java/de/cismet/remote/RESTRemoteControlMethodRegistry.java
@@ -37,11 +37,12 @@ private RESTRemoteControlMethodRegistry() {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * caches RemoteMethods to portMapping
*
- * @param defaultPort DOCUMENT ME!
+ * @param defaultPort default port
*
- * @throws IllegalStateException DOCUMENT ME!
+ * @throws IllegalStateException "RESTRemoteControlMethods have already been collected. "
+ + "Call RESTRemoteControlMethodRegistry.clear() to enable new gathering"
*/
public static synchronized void gatherRemoteMethods(final int defaultPort) {
if (!portMapping.isEmpty()) {
@@ -75,11 +76,11 @@ public static synchronized void gatherRemoteMethods(final int defaultPort) {
}
/**
- * DOCUMENT ME!
+ * Gets the Methods of specified Port
*
- * @param port DOCUMENT ME!
+ * @param port port
*
- * @return DOCUMENT ME!
+ * @return method
*/
public static synchronized List getMethodsForPort(final int port) {
final List methods = portMapping.get(port);
@@ -87,25 +88,25 @@ public static synchronized List getMethodsForPort(final
}
/**
- * DOCUMENT ME!
+ * Gettter for Methodports
*
- * @return DOCUMENT ME!
+ * @return Methodports
*/
public static synchronized Set getMethodPorts() {
return new HashSet(portMapping.keySet());
}
/**
- * DOCUMENT ME!
+ * Clears the Portmapping
*/
public static synchronized void clear() {
portMapping.clear();
}
/**
- * DOCUMENT ME!
+ * Tests whether the map is empty or not
*
- * @return DOCUMENT ME!
+ * @return True
if this map contains no key-value mappings
*/
public static synchronized boolean hasMethodsInformation() {
return portMapping.isEmpty();
diff --git a/src/main/java/de/cismet/remote/RESTRemoteControlMethodsApplication.java b/src/main/java/de/cismet/remote/RESTRemoteControlMethodsApplication.java
index 602b313..a9285c4 100644
--- a/src/main/java/de/cismet/remote/RESTRemoteControlMethodsApplication.java
+++ b/src/main/java/de/cismet/remote/RESTRemoteControlMethodsApplication.java
@@ -49,9 +49,9 @@ public RESTRemoteControlMethodsApplication() {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * collects Service Classes. Collects all available classes for this port.
*
- * @param portAsString DOCUMENT ME!
+ * @param portAsString portasString
*/
private void collectServiceClasses(final String portAsString) {
if (this.clazzes.isEmpty()) {
@@ -64,6 +64,11 @@ private void collectServiceClasses(final String portAsString) {
}
}
+ /**
+ * Getter for Classes
+ *
+ * @return class
+ */
@Override
public synchronized Set> getClasses() {
this.collectServiceClasses((String)rc.getProperty(PROP_PORT));
From 3b96ce44a68f28d1dcf72fe5694fc383969a8b63 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Fri, 4 Jan 2013 18:08:40 +0100
Subject: [PATCH 08/34] #9 Java Doc Improvements of Package de.cismet.tools
---
.../cismet/tools/BlacklistClassloading.java | 6 +-
src/main/java/de/cismet/tools/FileUtils.java | 86 +++++++++++--------
.../de/cismet/tools/PasswordEncrypter.java | 26 +++---
.../java/de/cismet/tools/PropertyReader.java | 18 ++--
.../java/de/cismet/tools/TextFromFile.java | 8 +-
5 files changed, 80 insertions(+), 64 deletions(-)
diff --git a/src/main/java/de/cismet/tools/BlacklistClassloading.java b/src/main/java/de/cismet/tools/BlacklistClassloading.java
index 6af8d18..d1ced1e 100644
--- a/src/main/java/de/cismet/tools/BlacklistClassloading.java
+++ b/src/main/java/de/cismet/tools/BlacklistClassloading.java
@@ -39,9 +39,11 @@ private BlacklistClassloading() {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * Tests whether the class is available or not.
+ * It sends messages to the Logger, if he can't find the class identity(additional he adds the identity on the blacklist),
+ * if he already has the class on the blacklist or if the classname was null
*
- * @param classname canonical classname to load
+ * @param classname classname to load
*
* @return the class to load or null if class is not found.
*/
diff --git a/src/main/java/de/cismet/tools/FileUtils.java b/src/main/java/de/cismet/tools/FileUtils.java
index dc0f7f7..9496f46 100644
--- a/src/main/java/de/cismet/tools/FileUtils.java
+++ b/src/main/java/de/cismet/tools/FileUtils.java
@@ -53,34 +53,36 @@ private FileUtils() {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * checks whether the File
is a MetaFiles
or not
*
- * @param check DOCUMENT ME!
+ * @param check File
to be tested
*
- * @return DOCUMENT ME!
+ * @return true if the tested File
is a MetaFile
+ *
+ * @see #isMetaFile(java.io.File, int)
*/
public static boolean isMetaFile(final File check) {
return isMetaFile(check, getMode());
}
/**
- * DOCUMENT ME!
+ * checks whether the File
is a MetaFile
of the tested OS
or not
*
- * @param check DOCUMENT ME!
- * @param mode DOCUMENT ME!
+ * @param check File
to be tested
+ * @param mode Number of OS
to be tested
*
- * @return DOCUMENT ME!
+ * @return true if the tested File
is a MetaFile
of the tested OS
*/
public static boolean isMetaFile(final File check, final int mode) {
return checkMeta(check.getName(), getMetaEntries(mode));
}
/**
- * DOCUMENT ME!
+ * get the MetaEntries
for the Meta
*
- * @param mode DOCUMENT ME!
+ * @param mode Metanumber
*
- * @return DOCUMENT ME!
+ * @return the MetaEntries
;By default returns All_Meta_Entries
*/
private static String[] getMetaEntries(final int mode) {
switch (mode) {
@@ -116,12 +118,12 @@ private static String[] getMetaEntries(final int mode) {
}
/**
- * DOCUMENT ME!
+ * Checks whether the File
has the Metaentries
or not
*
- * @param filename DOCUMENT ME!
- * @param meta DOCUMENT ME!
+ * @param filename name of the tested File
+ * @param meta Metaentries
to be tested
*
- * @return DOCUMENT ME!
+ * @return true if the File
has the tested Metaentries
;false if it's not
*/
private static boolean checkMeta(final String filename, final String[] meta) {
for (final String s : meta) {
@@ -133,9 +135,9 @@ private static boolean checkMeta(final String filename, final String[] meta) {
}
/**
- * DOCUMENT ME!
+ * gets the Meta
to the MetaFile
*
- * @return DOCUMENT ME!
+ * @return Meta
*/
private static int getMode() {
final String os = System.getProperty("os.name"); // NOI18N
@@ -151,11 +153,11 @@ private static int getMode() {
}
/**
- * DOCUMENT ME!
+ * gets the name of the File
*
- * @param file DOCUMENT ME!
+ * @param file
*
- * @return DOCUMENT ME!
+ * @return the FileName
*/
public static String getName(final File file) {
final String nameExt = file.getName();
@@ -185,25 +187,29 @@ public static String getExt(final File file) {
}
/**
- * DOCUMENT ME!
+ * Tests whether the File
only contains MetaFiles
or not
*
- * @param check DOCUMENT ME!
+ * @param check File
to be tested
*
- * @return DOCUMENT ME!
+ * @return true, if it only contains MetaFiles
+ *
+ * @see {@link #containsOnlyMetaFiles(java.io.File, int)}
*/
public static boolean containsOnlyMetaFiles(final File check) {
return containsOnlyMetaFiles(check, getMode());
}
/**
- * DOCUMENT ME!
+ * Tests whether the Directory
only contains MetaFiles
of one OS
+ *
+ * @param check File
to be tested
+ * @param mode Os
*
- * @param check DOCUMENT ME!
- * @param mode DOCUMENT ME!
+ * @return true, if it only contains MetaFiles
of the tested Os
*
- * @return DOCUMENT ME!
- *
- * @throws IllegalArgumentException DOCUMENT ME!
+ * @throws IllegalArgumentException throws IllegalArgumentException
if the File
isn't a Directory
+ *
+ * @see {@link #isMetaFile(java.io.File, int)}
*/
public static boolean containsOnlyMetaFiles(final File check, final int mode) {
if (!check.isDirectory()) {
@@ -219,11 +225,12 @@ public static boolean containsOnlyMetaFiles(final File check, final int mode) {
return true;
}
/**
- * exception thrown and not handled to avoid logger call if it is necessary to use logger in this class return
+ * copy the File<\code>
+ * Note: exception thrown and not handled to avoid logger call if it is necessary to use logger in this class return
* boolean and handle exceptions.
*
- * @param inFile DOCUMENT ME!
- * @param outFile DOCUMENT ME!
+ * @param inFile input File
+ * @param outFile target File
*
* @throws FileNotFoundException DOCUMENT ME!
* @throws IOException DOCUMENT ME!
@@ -250,14 +257,21 @@ public static void copyFile(final File inFile, final File outFile) throws FileNo
}
/**
- * DOCUMENT ME!
+ * Copys the Directory
. It uses the a filtered list of Files
contained inside the Directory
. If there is any Directory
the Method
starts recursive
*
- * @param srcDir DOCUMENT ME!
- * @param destDir DOCUMENT ME!
- * @param filter DOCUMENT ME!
+ * @param srcDir Source Directory
+ * @param destDir Target Directory
+ * @param filter Filter
* @param recursive DOCUMENT ME!
*
- * @throws FileNotFoundException DOCUMENT ME!
+ * @throws FileNotFoundException throws FileNotFoundException if:
+ *
+ *
+ * - the Source
File
or the Target File
does not exist
+ * - the Source
File
is not a Directory
+ * - the Target
File
is not a Directory
+ *
+ *
* @throws IOException DOCUMENT ME!
*/
public static void copyContent(
diff --git a/src/main/java/de/cismet/tools/PasswordEncrypter.java b/src/main/java/de/cismet/tools/PasswordEncrypter.java
index 80c34a5..5cd2637 100644
--- a/src/main/java/de/cismet/tools/PasswordEncrypter.java
+++ b/src/main/java/de/cismet/tools/PasswordEncrypter.java
@@ -235,31 +235,31 @@ public void focusGained(final java.awt.event.FocusEvent evt) {
} // //GEN-END:initComponents
/**
- * DOCUMENT ME!
+ * Focus Gained Password2
*
- * @param evt DOCUMENT ME!
+ * @param evt Event
*/
- private void pwfPassword2FocusGained(final java.awt.event.FocusEvent evt) { //GEN-FIRST:event_pwfPassword2FocusGained
+ private void pwfPassword2FocusGained(final java.awt.event.FocusEvent evt) {//GEN-FIRST:event_pwfPassword2FocusGained
pwfPassword2.setSelectionStart(0);
pwfPassword2.setSelectionEnd(pwfPassword1.getPassword().length);
- } //GEN-LAST:event_pwfPassword2FocusGained
+ }//GEN-LAST:event_pwfPassword2FocusGained
/**
- * DOCUMENT ME!
+ * Focus Gained Password1
*
- * @param evt DOCUMENT ME!
+ * @param evt Event
*/
- private void pwfPassword1FocusGained(final java.awt.event.FocusEvent evt) { //GEN-FIRST:event_pwfPassword1FocusGained
+ private void pwfPassword1FocusGained(final java.awt.event.FocusEvent evt) {//GEN-FIRST:event_pwfPassword1FocusGained
pwfPassword1.setSelectionStart(0);
pwfPassword1.setSelectionEnd(pwfPassword1.getPassword().length);
- } //GEN-LAST:event_pwfPassword1FocusGained
+ }//GEN-LAST:event_pwfPassword1FocusGained
/**
- * DOCUMENT ME!
+ * Starter
*
- * @param evt DOCUMENT ME!
+ * @param evt Event
*/
- private void cmdGoActionPerformed(final java.awt.event.ActionEvent evt) { //GEN-FIRST:event_cmdGoActionPerformed
+ private void cmdGoActionPerformed(final java.awt.event.ActionEvent evt) {//GEN-FIRST:event_cmdGoActionPerformed
final String p1 = new String(pwfPassword1.getPassword());
final String p2 = new String(pwfPassword2.getPassword());
if (p1.equals(p2)) {
@@ -296,10 +296,10 @@ private void cmdGoActionPerformed(final java.awt.event.ActionEvent evt) {
pwfPassword1.setText(""); // NOI18N
pwfPassword2.setText(""); // NOI18N
}
- } //GEN-LAST:event_cmdGoActionPerformed
+ }//GEN-LAST:event_cmdGoActionPerformed
/**
- * DOCUMENT ME!
+ * main
*
* @param args the command line arguments
*
diff --git a/src/main/java/de/cismet/tools/PropertyReader.java b/src/main/java/de/cismet/tools/PropertyReader.java
index 2bbe9e5..ee73dd5 100644
--- a/src/main/java/de/cismet/tools/PropertyReader.java
+++ b/src/main/java/de/cismet/tools/PropertyReader.java
@@ -39,9 +39,9 @@ public class PropertyReader {
/**
* Creates a new PropertyReader object.
*
- * @param filename DOCUMENT ME!
+ * @param filename filename
*
- * @throws IllegalArgumentException DOCUMENT ME!
+ * @throws IllegalArgumentException If filename is Null
*/
public PropertyReader(final String filename) {
if ((filename == null) || (filename.length() < 1)) {
@@ -69,29 +69,29 @@ public PropertyReader(final String filename) {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * get the Property.
*
- * @param key DOCUMENT ME!
+ * @param key key
*
- * @return DOCUMENT ME!
+ * @return the Property
of the properties
*/
public final String getProperty(final String key) {
return properties.getProperty(key);
}
/**
- * DOCUMENT ME!
+ * get the Filename.
*
- * @return the filename
+ * @return filename
*/
public String getFilename() {
return filename;
}
/**
- * DOCUMENT ME!
+ * get the Internal Propeties.
*
- * @return DOCUMENT ME!
+ * @return properties
*/
public Properties getInternalProperties() {
return properties;
diff --git a/src/main/java/de/cismet/tools/TextFromFile.java b/src/main/java/de/cismet/tools/TextFromFile.java
index db6c523..0c5e344 100644
--- a/src/main/java/de/cismet/tools/TextFromFile.java
+++ b/src/main/java/de/cismet/tools/TextFromFile.java
@@ -66,18 +66,18 @@ public TextFromFile(final String filepath) {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * Getter for Text. Converts Byte
to String
*
- * @return DOCUMENT ME!
+ * @return data
*/
public String getText() {
return new String(data);
}
/**
- * DOCUMENT ME!
+ * Getter for Text.
*
- * @return DOCUMENT ME!
+ * @return Vector
words
*/
public Vector getWordVector() {
final Vector words = new Vector(10, 10);
From 9105ad88960b66d92053b5d9fa271e10a27705bd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Mon, 7 Jan 2013 16:30:03 +0100
Subject: [PATCH 09/34] #9 Java Doc Improvements of package de.cismet.tools
---
src/main/java/de/cismet/tools/Base64.java | 2 +-
.../cismet/tools/BlacklistClassloading.java | 4 +-
src/main/java/de/cismet/tools/Calculator.java | 2 +-
.../de/cismet/tools/CismetThreadPool.java | 19 +--
.../java/de/cismet/tools/ConnectionInfo.java | 26 ++--
.../de/cismet/tools/CurrentStackTrace.java | 2 +-
.../java/de/cismet/tools/DebugSwitches.java | 6 +-
src/main/java/de/cismet/tools/Equals.java | 12 +-
src/main/java/de/cismet/tools/FileUtils.java | 127 ++++++++++++-----
src/main/java/de/cismet/tools/JnlpTools.java | 2 +-
.../de/cismet/tools/LinkedProperties.java | 133 +++++++++++++++++-
.../cismet/tools/NumberStringComparator.java | 12 +-
.../de/cismet/tools/PasswordEncrypter.java | 103 +++++++++++---
.../tools/PasswordEncrypterException.java | 2 +-
.../cismet/tools/PropertyEqualsProvider.java | 2 +-
.../java/de/cismet/tools/PropertyReader.java | 8 +-
.../java/de/cismet/tools/ScriptRunner.java | 48 +++----
src/main/java/de/cismet/tools/Sorter.java | 77 ++++++----
.../de/cismet/tools/StaticDebuggingTools.java | 8 +-
.../de/cismet/tools/StaticDecimalTools.java | 18 +--
.../java/de/cismet/tools/StaticHtmlTools.java | 30 ++--
.../java/de/cismet/tools/StaticXMLTools.java | 26 ++--
.../java/de/cismet/tools/StringTools.java | 8 +-
23 files changed, 471 insertions(+), 206 deletions(-)
diff --git a/src/main/java/de/cismet/tools/Base64.java b/src/main/java/de/cismet/tools/Base64.java
index 38d49c6..a74dae2 100644
--- a/src/main/java/de/cismet/tools/Base64.java
+++ b/src/main/java/de/cismet/tools/Base64.java
@@ -8,7 +8,7 @@
package de.cismet.tools;
/**
- * DOCUMENT ME!
+ * Base64 Converter
*
* @author martin.scholl@cismet.de
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/BlacklistClassloading.java b/src/main/java/de/cismet/tools/BlacklistClassloading.java
index d1ced1e..90ae250 100644
--- a/src/main/java/de/cismet/tools/BlacklistClassloading.java
+++ b/src/main/java/de/cismet/tools/BlacklistClassloading.java
@@ -13,7 +13,7 @@
import java.util.Map;
/**
- * DOCUMENT ME!
+ * Blacklist
*
* @author srichter
* @version $Revision$, $Date$
@@ -30,7 +30,7 @@ public final class BlacklistClassloading {
/**
* Creates a new BlacklistClassloading object.
*
- * @throws AssertionError DOCUMENT ME!
+ * @throws AssertionError Assertion failed
*/
private BlacklistClassloading() {
throw new AssertionError();
diff --git a/src/main/java/de/cismet/tools/Calculator.java b/src/main/java/de/cismet/tools/Calculator.java
index fcd2d7e..911d833 100644
--- a/src/main/java/de/cismet/tools/Calculator.java
+++ b/src/main/java/de/cismet/tools/Calculator.java
@@ -8,7 +8,7 @@
package de.cismet.tools;
/**
- * DOCUMENT ME!
+ * Calculator
*
* @author therter
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/CismetThreadPool.java b/src/main/java/de/cismet/tools/CismetThreadPool.java
index ae908a9..882f391 100644
--- a/src/main/java/de/cismet/tools/CismetThreadPool.java
+++ b/src/main/java/de/cismet/tools/CismetThreadPool.java
@@ -36,7 +36,7 @@ public final class CismetThreadPool {
* Executes the given runnable in the applications common cached threadpool. Notice: It is smarter to pass plain
* Runnables instead of Threads as arguments, as one purpose of this pool is minimizing thread creation overhead.
*
- * @param command DOCUMENT ME!
+ * @param command given runnable
*/
public static void execute(final Runnable command) {
WORKER_POOL.execute(command);
@@ -46,27 +46,29 @@ public static void execute(final Runnable command) {
* Executes the given runnable in the applications threadpool. All threads, which will be started with this method
* will be run sequentially.
*
- * @param command DOCUMENT ME!
+ * @param command given runnable
*/
public static void executeSequentially(final Runnable command) {
SINGLE_WORKER_POOL.execute(command);
}
/**
- * DOCUMENT ME!
+ * Submits the given runnable in the applications common cached threadpool.
*
- * @param command DOCUMENT ME!
+ * @param command given runnable
*
- * @return DOCUMENT ME!
+ * @return a Future representing pending completion of the runnable
*/
public static Future> submit(final Runnable command) {
return WORKER_POOL.submit(command);
}
/**
- * DOCUMENT ME!
+ * Attempts to stop all actively executing tasks, halts the
+ * processing of waiting tasks, and returns a list of the tasks
+ * that were awaiting execution.
*
- * @return DOCUMENT ME!
+ * @return list
*/
public static List shutdownNow() {
final List list = SINGLE_WORKER_POOL.shutdownNow();
@@ -75,7 +77,8 @@ public static List shutdownNow() {
}
/**
- * DOCUMENT ME!
+ * Initiates an orderly shutdown in which previously submitted
+ * tasks are executed, but no new tasks will be accepted.
*/
public static void shutdown() {
SINGLE_WORKER_POOL.shutdown();
diff --git a/src/main/java/de/cismet/tools/ConnectionInfo.java b/src/main/java/de/cismet/tools/ConnectionInfo.java
index 562e748..734941e 100644
--- a/src/main/java/de/cismet/tools/ConnectionInfo.java
+++ b/src/main/java/de/cismet/tools/ConnectionInfo.java
@@ -15,7 +15,7 @@
import org.jdom.Element;
/**
- * Bean Klasse zum speichern von Connection Infos.
+ * Bean Class to save Connection Infos.
*
* @author hell
* @version $Revision$, $Date$
@@ -40,7 +40,7 @@ public ConnectionInfo() {
/**
* Creates a new ConnectionInfo object.
*
- * @param element DOCUMENT ME!
+ * @param element Elemtent
*/
public ConnectionInfo(final Element element) { // throws NullPointerException{
driver = element.getChild("driverClass").getTextTrim(); // NOI18N
@@ -52,7 +52,7 @@ public ConnectionInfo(final Element element) { // throws NullPointe
//~ Methods ----------------------------------------------------------------
/**
- * Gibt die Driver Klasse zur\u00FCck.
+ * Returns the DriverClass
*
* @return DriverClass
*/
@@ -61,7 +61,7 @@ public String getDriver() {
}
/**
- * Setzt die Treiber Klasse.
+ * Sets the DriverClass
*
* @param driver Driver Class
*/
@@ -70,7 +70,7 @@ public void setDriver(final String driver) {
}
/**
- * Liefert die DB Url.
+ * Returns the DB Url
*
* @return DB Url
*/
@@ -79,7 +79,7 @@ public String getUrl() {
}
/**
- * Setzt die DB Url.
+ * Sets the DB Url
*
* @param url DB Url
*/
@@ -88,7 +88,7 @@ public void setUrl(final String url) {
}
/**
- * Liefert den User.
+ * Getter for User.
*
* @return DB USer
*/
@@ -97,7 +97,7 @@ public String getUser() {
}
/**
- * Setzt den User.
+ * Setter for User.
*
* @param user DB User
*/
@@ -106,9 +106,9 @@ public void setUser(final String user) {
}
/**
- * Liefert Passwort.
+ * Returns Password.
*
- * @return Pass
+ * @return Password
*/
public String getPass() {
if ((pass != null) && pass.startsWith(PasswordEncrypter.CRYPT_PREFIX)) {
@@ -119,7 +119,7 @@ public String getPass() {
}
/**
- * Setzt Passwort.
+ * Sets Password
*
* @param pass Password
*/
@@ -128,9 +128,9 @@ public void setPass(final String pass) {
}
/**
- * DOCUMENT ME!
+ * Getter for Element
*
- * @return DOCUMENT ME!
+ * @return Element
*/
public Element getElement() {
final Element e = new Element("dbConnectionInfo"); // NOI18N
diff --git a/src/main/java/de/cismet/tools/CurrentStackTrace.java b/src/main/java/de/cismet/tools/CurrentStackTrace.java
index 635649b..6f50ef3 100644
--- a/src/main/java/de/cismet/tools/CurrentStackTrace.java
+++ b/src/main/java/de/cismet/tools/CurrentStackTrace.java
@@ -12,7 +12,7 @@
package de.cismet.tools;
/**
- * DOCUMENT ME!
+ * CurrentStackTrace
*
* @author thorsten
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/DebugSwitches.java b/src/main/java/de/cismet/tools/DebugSwitches.java
index 6d8639a..c9914ba 100644
--- a/src/main/java/de/cismet/tools/DebugSwitches.java
+++ b/src/main/java/de/cismet/tools/DebugSwitches.java
@@ -12,7 +12,7 @@
package de.cismet.tools;
/**
- * DOCUMENT ME!
+ * debug Switches
*
* @author thorsten
* @version $Revision$, $Date$
@@ -38,9 +38,9 @@ private DebugSwitches() {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * Getter for Instance
*
- * @return DOCUMENT ME!
+ * @return instance
*/
public static DebugSwitches getInstance() {
if (instance == null) {
diff --git a/src/main/java/de/cismet/tools/Equals.java b/src/main/java/de/cismet/tools/Equals.java
index 0aac037..20468fd 100644
--- a/src/main/java/de/cismet/tools/Equals.java
+++ b/src/main/java/de/cismet/tools/Equals.java
@@ -32,10 +32,10 @@ private Equals() {
* Compares the bean properties of given objects. This operation is equivalent to calling
* {@link #beanDeepEqual(java.lang.Object, java.lang.Object, java.lang.String[])} with a null String[]
.
*
- * @param o DOCUMENT ME!
- * @param o2 DOCUMENT ME!
+ * @param o object one
+ * @param o2 object two
*
- * @return DOCUMENT ME!
+ * @return true, if obeject one and object two deliver the same result for every bean getter
*
* @see #beanDeepEqual(java.lang.Object, java.lang.Object, java.lang.String[])
*/
@@ -88,8 +88,8 @@ public static boolean beanDeepEqual(final Object o, final Object o2, final Strin
/**
* Tests if the given array contains the given name.
*
- * @param name DOCUMENT ME!
- * @param array DOCUMENT ME!
+ * @param name searched name
+ * @param array given array
*
* @return true, if the array contains the name, false otherwise, also false if the array is null
*/
@@ -120,7 +120,7 @@ private static boolean contains(final String name, final String... array) {
*
*
*
- * @param m DOCUMENT ME!
+ * @param m given method
*
* @return true
if all the requirements listed above are met, false
otherwise
*/
diff --git a/src/main/java/de/cismet/tools/FileUtils.java b/src/main/java/de/cismet/tools/FileUtils.java
index 9496f46..691c6b0 100644
--- a/src/main/java/de/cismet/tools/FileUtils.java
+++ b/src/main/java/de/cismet/tools/FileUtils.java
@@ -21,7 +21,7 @@
import java.util.jar.JarFile;
/**
- * DOCUMENT ME!
+ * FileUtils Class
*
* @author mscholl
* @version 1.3
@@ -53,7 +53,7 @@ private FileUtils() {
//~ Methods ----------------------------------------------------------------
/**
- * checks whether the File
is a MetaFiles
or not
+ * Checks whether the File
is a MetaFiles
or not
*
* @param check File
to be tested
*
@@ -66,7 +66,7 @@ public static boolean isMetaFile(final File check) {
}
/**
- * checks whether the File
is a MetaFile
of the tested OS
or not
+ * Checks whether the File
is a MetaFile
of the tested OS
or not
*
* @param check File
to be tested
* @param mode Number of OS
to be tested
@@ -135,7 +135,7 @@ private static boolean checkMeta(final String filename, final String[] meta) {
}
/**
- * gets the Meta
to the MetaFile
+ * Tests which OS the System is running.
*
* @return Meta
*/
@@ -153,11 +153,11 @@ private static int getMode() {
}
/**
- * gets the name of the File
+ * Getter for the name of the File
*
- * @param file
+ * @param file given File
*
- * @return the FileName
+ * @return FileName
*/
public static String getName(final File file) {
final String nameExt = file.getName();
@@ -170,11 +170,11 @@ public static String getName(final File file) {
}
/**
- * DOCUMENT ME!
+ * Getter for the Filestype
*
- * @param file DOCUMENT ME!
+ * @param file given file
*
- * @return DOCUMENT ME!
+ * @return Filetype as String
*/
public static String getExt(final File file) {
final String nameExt = file.getName();
@@ -200,7 +200,7 @@ public static boolean containsOnlyMetaFiles(final File check) {
}
/**
- * Tests whether the Directory
only contains MetaFiles
of one OS
+ * Tests whether the Directory
only contains MetaFiles
of the given OS
*
* @param check File
to be tested
* @param mode Os
@@ -209,7 +209,7 @@ public static boolean containsOnlyMetaFiles(final File check) {
*
* @throws IllegalArgumentException throws IllegalArgumentException
if the File
isn't a Directory
*
- * @see {@link #isMetaFile(java.io.File, int)}
+ * @see #isMetaFile(java.io.File, int)
*/
public static boolean containsOnlyMetaFiles(final File check, final int mode) {
if (!check.isDirectory()) {
@@ -225,15 +225,16 @@ public static boolean containsOnlyMetaFiles(final File check, final int mode) {
return true;
}
/**
- * copy the File<\code>
+ * Copies the File
* Note: exception thrown and not handled to avoid logger call if it is necessary to use logger in this class return
* boolean and handle exceptions.
*
* @param inFile input File
* @param outFile target File
*
- * @throws FileNotFoundException DOCUMENT ME!
- * @throws IOException DOCUMENT ME!
+ * @throws FileNotFoundException FileNotFoundException
+ * @throws IOException IOException
+ *
*/
public static void copyFile(final File inFile, final File outFile) throws FileNotFoundException, IOException {
FileInputStream fis = null;
@@ -262,17 +263,17 @@ public static void copyFile(final File inFile, final File outFile) throws FileNo
* @param srcDir Source Directory
* @param destDir Target Directory
* @param filter Filter
- * @param recursive DOCUMENT ME!
+ * @param recursive recursive
*
* @throws FileNotFoundException throws FileNotFoundException if:
*
*
- * - the Source
File
or the Target File
does not exist
* - the Source
File
is not a Directory
* - the Target
File
is not a Directory
*
*
- * @throws IOException DOCUMENT ME!
+ * @throws IOException IOException
+ *
*/
public static void copyContent(
final File srcDir,
@@ -305,12 +306,17 @@ public static void copyContent(
}
/**
- * DOCUMENT ME!
+ * Deletes the Content of the Given Folder.
*
- * @param srcDir DOCUMENT ME!
- * @param recursive DOCUMENT ME!
+ * @param srcDir given Directory
+ * @param recursive recursive
*
- * @throws IOException DOCUMENT ME!
+ * @throws IOException IOException
+ *
+ * - source dir is not a directory
+ * - a File couldn't be deleted
+ * - a Folder couldn't be deleted
+ *
*/
public static void deleteContent(final File srcDir, final boolean recursive) throws IOException {
if (!srcDir.isDirectory()) {
@@ -339,11 +345,15 @@ public static void deleteContent(final File srcDir, final boolean recursive) thr
}
/**
- * DOCUMENT ME!
+ * Deletes the Given Folder
*
- * @param srcDir DOCUMENT ME!
+ * @param srcDir given Directory
*
- * @throws IOException DOCUMENT ME!
+ * @throws IOException IOException
+ *
+ * - Source Directory is not a Directory
+ * - Could not delete File
+ *
*/
public static void deleteDir(final File srcDir) throws IOException {
if (!srcDir.isDirectory()) {
@@ -360,13 +370,21 @@ public static void deleteDir(final File srcDir) throws IOException {
}
/**
- * DOCUMENT ME!
+ * Extracts given Jar File to given Folder
*
- * @param jar DOCUMENT ME!
- * @param dest DOCUMENT ME!
- * @param filter DOCUMENT ME!
+ * @param jar Jar File
+ * @param dest Directory
+ * @param filter filter
*
- * @throws IOException DOCUMENT ME!
+ * @throws IOException IOException
+ *
+ * - dest dir does not exist
+ * - jar file does not exist
+ * - dest dir is not a directory
+ * - cannot write to dest directory
+ * - cannot read jar file
+ * - culd not create dir
+ *
*/
public static void extractJar(final File jar, final File dest, final FileFilter filter) throws IOException {
if (!dest.exists()) {
@@ -424,7 +442,7 @@ public static void extractJar(final File jar, final File dest, final FileFilter
//~ Inner Classes ----------------------------------------------------------
/**
- * DOCUMENT ME!
+ * Inner Class JarFilter
*
* @version $Revision$, $Date$
*/
@@ -432,6 +450,13 @@ public static final class JarFilter implements FileFilter {
//~ Methods ------------------------------------------------------------
+ /**
+ * Tests whether the given File
is .jar File
or not
+ *
+ * @param file given File
+ *
+ * @return true, if the File
is a .jar File
+ */
@Override
public boolean accept(final File file) {
return getExt(file).equalsIgnoreCase("jar"); // NOI18N
@@ -439,7 +464,7 @@ public boolean accept(final File file) {
}
/**
- * DOCUMENT ME!
+ * Inner Class DirandJarFilter
*
* @version $Revision$, $Date$
*/
@@ -447,6 +472,13 @@ public static final class DirAndJarFilter implements FileFilter {
//~ Methods ------------------------------------------------------------
+ /**
+ * Tests whether the File
is a Directory
or a .jar File
+ *
+ * @param file given File
+ *
+ * @return true, if the File
is a .jar File
or a Directory
+ */
@Override
public boolean accept(final File file) {
return file.isDirectory() || getExt(file).equalsIgnoreCase("jar"); // NOI18N
@@ -454,7 +486,7 @@ public boolean accept(final File file) {
}
/**
- * DOCUMENT ME!
+ * Inner Class DirectoryFilter
*
* @version $Revision$, $Date$
*/
@@ -462,6 +494,14 @@ public static final class DirectoryFilter implements FileFilter {
//~ Methods ------------------------------------------------------------
+ /**
+ * Tests whether the File
is Directory
or not.
+ *
+ * @param file given File
+ *
+ * @return true, if the File
is a Directory
+ */
+
@Override
public boolean accept(final File file) {
return file.isDirectory();
@@ -469,7 +509,7 @@ public boolean accept(final File file) {
}
/**
- * DOCUMENT ME!
+ * Inner Class FilesFilter
*
* @version $Revision$, $Date$
*/
@@ -477,6 +517,14 @@ public static final class FilesFilter implements FileFilter {
//~ Methods ------------------------------------------------------------
+ /**
+ * Tests whether the File
is Directory
or not.
+ *
+ * @param file given File
+ *
+ * @return true, if the File
is a Directory
+ */
+
@Override
public boolean accept(final File file) {
return !file.isDirectory();
@@ -484,14 +532,21 @@ public boolean accept(final File file) {
}
/**
- * DOCUMENT ME!
+ * Inner Class MetaInfFilter
*
* @version $Revision$, $Date$
*/
public static final class MetaInfFilter implements FileFilter {
//~ Methods ------------------------------------------------------------
-
+
+ /**
+ * Tests whether the File
is Meta File
or not.
+ *
+ * @param file given File
+ *
+ * @return true, if the File
is a Meta File
+ */
@Override
public boolean accept(final File file) {
return !file.getAbsolutePath().contains(File.separator + "META-INF"); // NOI18N
diff --git a/src/main/java/de/cismet/tools/JnlpTools.java b/src/main/java/de/cismet/tools/JnlpTools.java
index 1d7f1d5..a280958 100644
--- a/src/main/java/de/cismet/tools/JnlpTools.java
+++ b/src/main/java/de/cismet/tools/JnlpTools.java
@@ -10,7 +10,7 @@
import java.util.Locale;
/**
- * DOCUMENT ME!
+ * JnlpTools Class
*
* @author martin.scholl@cismet.de
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/LinkedProperties.java b/src/main/java/de/cismet/tools/LinkedProperties.java
index 715edd9..8c580a7 100644
--- a/src/main/java/de/cismet/tools/LinkedProperties.java
+++ b/src/main/java/de/cismet/tools/LinkedProperties.java
@@ -20,7 +20,7 @@
import java.util.Set;
/**
- * DOCUMENT ME!
+ * Linked Properties
*
* @author thorsten
* @version $Revision$, $Date$
@@ -32,97 +32,209 @@ public class LinkedProperties extends Properties {
private final LinkedHashMap map = new LinkedHashMap();
//~ Methods ----------------------------------------------------------------
-
+
+ /**
+ * Associates a given value
with a given key
value
associated with key
, or
+ * null
if there was no mapping for key
.
+ * (A null
return can also indicate that the map
+ * previously associated null
with key
.)
+ */
+
@Override
public synchronized Object put(final Object key, final Object value) {
return map.put(key, value);
}
+ /**
+ * Returns the value
for the given key
+ *
+ * @param key
+ *
+ * @return the associated value
. Returns null
, if the is no mapping for this key.
+ */
@Override
public synchronized Object get(final Object key) {
return map.get(key);
}
+ /**
+ * Removes every mapping
of this map
+ */
+
@Override
public synchronized void clear() {
map.clear();
}
+ /**
+ * @throws UnsupportedOperationException
+ */
@Override
public synchronized Object clone() {
throw new UnsupportedOperationException();
}
+ /**
+ * Tests whether there is any mapping
with this value
or not
+ *
+ * @param value value whose presence in this map is to be tested
+ *
+ * @return True, if there is a key
with this value
+ */
@Override
public boolean containsValue(final Object value) {
return map.containsValue(value);
}
+ /**
+ * Tests whether there is any mapping
with this value
or not
+ *
+ * @param value value whose presence in this map is to be tested
+ *
+ * @return True, if there is a key
with this value
+ */
+
@Override
public synchronized boolean contains(final Object value) {
return containsValue(value);
}
+ /**
+ * Tests whether the specified key is in the map or not
+ *
+ * @param key key whose presence in this map is to be tested
+ *
+ * @return True, if there is a key
+ */
+
@Override
public synchronized boolean containsKey(final Object key) {
return map.containsKey(key);
}
+ /**
+ * Returns all values
. Uses an Iterator
over all elements
.
+ *
+ * @return every value
in this map
+ */
@Override
public synchronized Enumeration elements() {
return new IteratorEnumeration(map.values().iterator());
}
+ /**
+ * Returns a Set
view of the mappings contained in this map.
+ *
+ * @return Set
+ */
@Override
public Set entrySet() {
return map.entrySet();
}
+ /**
+ * @throws UnsupportedOperationException
+ */
+
@Override
public synchronized boolean equals(final Object o) {
throw new UnsupportedOperationException();
}
+ /**
+ * Tests whether there is any mapping on the map or not
+ *
+ * @return true, if there is no mapping
+ */
@Override
public synchronized boolean isEmpty() {
return map.isEmpty();
}
+ /**
+ * Returns all keys
. Uses an Iterator
over all elements
.
+ *
+ * @return every key
in this map
+ */
@Override
public synchronized Enumeration keys() {
return new IteratorEnumeration(map.keySet().iterator());
}
+ /**
+ * Returns a Set
view of the keys contained in this map.
+ *
+ * @return Set
+ */
@Override
public Set keySet() {
return map.keySet();
}
+ /**
+ * @throws UnsupportedOperationException
+ */
@Override
public Enumeration propertyNames() {
throw new UnsupportedOperationException();
}
+ /**
+ * Copies all of the mappings
from the specified map
to this map
.
+ * These mappings
will replace any mappings
that this map
had for
+ * any of the keys
currently in the specified map
+ *
+ * @param t map
+ */
@Override
public synchronized void putAll(final Map t) {
map.putAll(t);
}
+ /**
+ * Removes specified key
+ * @param key key
+ * @return the previous value
associated with key
, or
+ * null
if there was no mapping for key
.
+ */
@Override
public synchronized Object remove(final Object key) {
return map.remove(key);
}
+ /**
+ * Returns the number of key-value mappings in this map.
+ *
+ * @return the number of key-value mappings in this map
+ */
@Override
public synchronized int size() {
return map.size();
}
+ /**
+ * @throws UnsupportedOperationException
+ */
@Override
public Collection values() {
throw new UnsupportedOperationException();
}
+ /**
+ * Searches for the property with the specified key in this property list.
+ * If the key is not found in this property list, the default property list,
+ * and its defaults, recursively, are then checked. The method returns
+ * null
if the property is not found.
+ *
+ * @param key the property key
+ *
+ * @return the value in this property list with the specified key value.
+ */
@Override
public String getProperty(final String key) {
final Object oval = get(key);
@@ -132,7 +244,7 @@ public String getProperty(final String key) {
}
/**
- * DOCUMENT ME!
+ * IteratorEnumeration
*
* @version $Revision$, $Date$
*/
@@ -147,9 +259,9 @@ class IteratorEnumeration implements Enumeration {
/**
* Creates a new IteratorEnumeration object.
*
- * @param i DOCUMENT ME!
+ * @param i Iterator
*
- * @throws IllegalArgumentException DOCUMENT ME!
+ * @throws IllegalArgumentException Iterator is null
*/
public IteratorEnumeration(final Iterator i) {
if (i == null) {
@@ -160,11 +272,22 @@ public IteratorEnumeration(final Iterator i) {
//~ Methods ----------------------------------------------------------------
+ /**
+ * Tests whether the Iterator
as more Elemtents or not.
+ *
+ * @return True
, if the Iterator
has more Elements.
+ */
@Override
public boolean hasMoreElements() {
return iterator.hasNext();
}
+ /**
+ * Returns the next element in the iteration.
+ *
+ * @return the next element in the iteration
+ * @throws NoSuchElementException if the iteration has no more elements
+ */
@Override
public Object nextElement() {
return iterator.next();
diff --git a/src/main/java/de/cismet/tools/NumberStringComparator.java b/src/main/java/de/cismet/tools/NumberStringComparator.java
index 2b0f2f1..0b80d16 100644
--- a/src/main/java/de/cismet/tools/NumberStringComparator.java
+++ b/src/main/java/de/cismet/tools/NumberStringComparator.java
@@ -13,8 +13,8 @@
package de.cismet.tools;
/**
- * Comparator f\u00FCr Inhalte die Zahlen und Strings fassen k\u00F6nnen
- * Es wird folgenderma\u00DFem sortiert:
+ * Comperator for Objects, which can contain Numbers and Strings.
+ * It will be sorted in the following form:
* 1
* 2
* 3
@@ -56,12 +56,12 @@ public NumberStringComparator() {
//~ Methods ----------------------------------------------------------------
/**
- * Vergleichsfunktion.
+ * Compare Methode
*
- * @param o1 erstes Objekt
- * @param o2 zweites Objekt
+ * @param o1 Object one
+ * @param o2 object two
*
- * @return Vergleichsergebniss
+ * @return value of the Comparation
*/
@Override
public int compare(final Object o1, final Object o2) {
diff --git a/src/main/java/de/cismet/tools/PasswordEncrypter.java b/src/main/java/de/cismet/tools/PasswordEncrypter.java
index 5cd2637..d426f38 100644
--- a/src/main/java/de/cismet/tools/PasswordEncrypter.java
+++ b/src/main/java/de/cismet/tools/PasswordEncrypter.java
@@ -38,7 +38,7 @@
import javax.swing.UIManager;
/**
- * DOCUMENT ME!
+ * Applet Password Encrypter
*
* @author thorsten.hell@cismet.de
* @author martin.scholl@cismet.de
@@ -303,7 +303,7 @@ private void cmdGoActionPerformed(final java.awt.event.ActionEvent evt) {//GEN-F
*
* @param args the command line arguments
*
- * @throws Exception DOCUMENT ME!
+ * @throws Exception
*/
public static void main(final String[] args) throws Exception {
java.awt.EventQueue.invokeLater(new Runnable() {
@@ -321,11 +321,11 @@ public void run() {
}
/**
- * DOCUMENT ME!
+ * Decrypts String
with BlowfishEasy
*
- * @param code DOCUMENT ME!
+ * @param code String
that should get decrypted
*
- * @return DOCUMENT ME!
+ * @return Return decrypted code or null
if code was set to null
*
* @throws PasswordEncrypterException DOCUMENT ME!
*/
@@ -341,11 +341,11 @@ public static String decryptString(String code) throws PasswordEncrypterExceptio
}
/**
- * DOCUMENT ME!
+ * Encrypts a specified String
using BlowfishEasy.
*
- * @param pwd DOCUMENT ME!
+ * @param pwd String
that shoudl get encrypted
*
- * @return DOCUMENT ME!
+ * @return encrypted String
*
* @throws PasswordEncrypterException DOCUMENT ME!
*/
@@ -527,15 +527,15 @@ public static char[] decrypt(final char[] string, final boolean wipeInput) throw
}
/**
- * DOCUMENT ME!
+ * Applies Cipher
*
- * @param bytes string DOCUMENT ME!
- * @param mode DOCUMENT ME!
+ * @param bytes string
+ * @param mode mode
*
- * @return DOCUMENT ME!
+ * @return byte
*
- * @throws IllegalArgumentException DOCUMENT ME!
- * @throws PasswordEncrypterException DOCUMENT ME!
+ * @throws IllegalArgumentException given byte is null
+ * @throws PasswordEncrypterException cannot process String
mode
*/
private static byte[] applyCipher(final byte[] bytes, final int mode) {
if (bytes == null) {
@@ -570,11 +570,15 @@ private static byte[] applyCipher(final byte[] bytes, final int mode) {
}
/**
- * DOCUMENT ME!
+ * Getter for Master Password
*
- * @return DOCUMENT ME!
+ * @return masterpassword as Char[]
*
- * @throws PasswordEncrypterException DOCUMENT ME!
+ * @throws PasswordEncrypterException
+ *
+ * - PasswordEncrypter properties not present.
+ * - cannot read master password from properties, not set?
+ *
*/
private static char[] getMasterPw() throws PasswordEncrypterException {
final InputStream peStream = PasswordEncrypter.class.getResourceAsStream("PasswordEncrypter.properties"); // NOI18N
@@ -604,11 +608,14 @@ private static char[] getMasterPw() throws PasswordEncrypterException {
}
/**
- * Always 8 bytes.
+ * Get Salt.Always 8 bytes.
+ * Uses Default Salt, if Salt not set.
+ * If Salt is shorter then eight bytes the rest of the Salt will filled with default Salt.
+ * If Salt is too long, returns only the first eight bytes
*
- * @return DOCUMENT ME!
+ * @return salt
*
- * @throws PasswordEncrypterException DOCUMENT ME!
+ * @throws PasswordEncrypterException PasswordEncrypter properties not present
*/
private static byte[] getSalt() throws PasswordEncrypterException {
final InputStream peStream = PasswordEncrypter.class.getResourceAsStream("PasswordEncrypter.properties"); // NOI18N
@@ -839,7 +846,7 @@ public static byte[] safeRead(final InputStream propertyStream, final char[] pro
//~ Inner Classes ----------------------------------------------------------
/**
- * DOCUMENT ME!
+ * FocusTraversalOrder
*
* @version $Revision$, $Date$
*/
@@ -865,13 +872,31 @@ public FocusTraversalOrder() {
//~ Methods ------------------------------------------------------------
+ /**
+ * Returns the following Component
of the specified Component
+ * If the specified Component
is the Last, Returns the First Component
+ *
+ * @param aContainer Container
+ * @param aComponent Component
+ *
+ * @return following Component
+ */
@Override
public Component getComponentAfter(final Container aContainer, final Component aComponent) {
final int index = (order.indexOf(aComponent) + 1) % order.size();
return order.get(index);
}
-
+
+ /**
+ * Returns the previous Component
of the specified Component
+ * If the specified Component
is the First, Returns the Last Component
+ *
+ * @param aContainer Container
+ * @param aComponent Component
+ *
+ * @return previous Component
+ */
@Override
public Component getComponentBefore(final Container aContainer, final Component aComponent) {
int index = order.indexOf(aComponent) - 1;
@@ -882,16 +907,37 @@ public Component getComponentBefore(final Container aContainer, final Component
return order.get(index);
}
+ /**
+ * Returns the First Component
+ *
+ * @param aContainer Container
+ *
+ * @return Component
+ */
@Override
public Component getFirstComponent(final Container aContainer) {
return order.get(0);
}
+ /**
+ * Returns the Last Component
+ *
+ * @param aContainer Container
+ *
+ * @return Component
+ */
@Override
public Component getLastComponent(final Container aContainer) {
return order.get(order.size() - 1);
}
+ /**
+ * Returns the First Component
+ *
+ * @param aContainer Container
+ *
+ * @return Component
+ */
@Override
public Component getDefaultComponent(final Container aContainer) {
return order.get(0);
@@ -899,7 +945,7 @@ public Component getDefaultComponent(final Container aContainer) {
}
/**
- * DOCUMENT ME!
+ * Code Focus Listener
*
* @version $Revision$, $Date$
*/
@@ -912,6 +958,12 @@ private final class CodeFocusListener implements FocusListener {
//~ Methods ------------------------------------------------------------
+ /**
+ * Sets the Focus on txaCode
from selStart
to selEnd
+ * If the Selected Area is Empty, Selects all.
+ *
+ * @param e Event
+ */
@Override
public void focusGained(final FocusEvent e) {
if (selStart < selEnd) {
@@ -923,6 +975,11 @@ public void focusGained(final FocusEvent e) {
}
}
+ /**
+ * Gets the Focus on txaCode
and saves the Start to selStart
and the End to selEnd
+ *
+ * @param e Event
+ */
@Override
public void focusLost(final FocusEvent e) {
// preserve selection
diff --git a/src/main/java/de/cismet/tools/PasswordEncrypterException.java b/src/main/java/de/cismet/tools/PasswordEncrypterException.java
index 0a3652d..bb9506e 100644
--- a/src/main/java/de/cismet/tools/PasswordEncrypterException.java
+++ b/src/main/java/de/cismet/tools/PasswordEncrypterException.java
@@ -8,7 +8,7 @@
package de.cismet.tools;
/**
- * DOCUMENT ME!
+ * Password Encrypter Exception
*
* @author martin.scholl@cismet.de
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/PropertyEqualsProvider.java b/src/main/java/de/cismet/tools/PropertyEqualsProvider.java
index f6beb13..24f223a 100644
--- a/src/main/java/de/cismet/tools/PropertyEqualsProvider.java
+++ b/src/main/java/de/cismet/tools/PropertyEqualsProvider.java
@@ -24,7 +24,7 @@
package de.cismet.tools;
/**
- * DOCUMENT ME!
+ * Property Equals Provideer
*
* @author thorsten
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/PropertyReader.java b/src/main/java/de/cismet/tools/PropertyReader.java
index ee73dd5..ee26466 100644
--- a/src/main/java/de/cismet/tools/PropertyReader.java
+++ b/src/main/java/de/cismet/tools/PropertyReader.java
@@ -18,7 +18,7 @@
import java.util.Properties;
/**
- * DOCUMENT ME!
+ * Property Reader
*
* @author srichter
* @version $Revision$, $Date$
@@ -69,7 +69,7 @@ public PropertyReader(final String filename) {
//~ Methods ----------------------------------------------------------------
/**
- * get the Property.
+ * Gets the Property.
*
* @param key key
*
@@ -80,7 +80,7 @@ public final String getProperty(final String key) {
}
/**
- * get the Filename.
+ * Gets the Filename.
*
* @return filename
*/
@@ -89,7 +89,7 @@ public String getFilename() {
}
/**
- * get the Internal Propeties.
+ * Gets the Internal Propeties.
*
* @return properties
*/
diff --git a/src/main/java/de/cismet/tools/ScriptRunner.java b/src/main/java/de/cismet/tools/ScriptRunner.java
index 75f570c..9c328b7 100644
--- a/src/main/java/de/cismet/tools/ScriptRunner.java
+++ b/src/main/java/de/cismet/tools/ScriptRunner.java
@@ -68,9 +68,9 @@ public class ScriptRunner {
/**
* Default constructor.
*
- * @param connection DOCUMENT ME!
- * @param autoCommit DOCUMENT ME!
- * @param stopOnError DOCUMENT ME!
+ * @param connection Connection
+ * @param autoCommit Enables/Disables autoCommit
+ * @param stopOnError Enables/Disables stopOnError
*/
public ScriptRunner(final Connection connection, final boolean autoCommit, final boolean stopOnError) {
this.connection = connection;
@@ -81,27 +81,27 @@ public ScriptRunner(final Connection connection, final boolean autoCommit, final
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * Setter for delimiter
property
*
- * @param delimiter DOCUMENT ME!
+ * @param delimiter new vslue of the delimiter
property
*/
public void setDelimiter(final String delimiter) {
this.delimiter = delimiter;
}
/**
- * Setter for logWriter property.
+ * Setter for logWriter
property.
*
- * @param logWriter - the new value of the logWriter property
+ * @param logWriter - the new value of the logWriter
property
*/
public void setLogWriter(final PrintWriter logWriter) {
this.logWriter = logWriter;
}
/**
- * Setter for errorLogWriter property.
+ * Setter for errorLogWriter
property.
*
- * @param errorLogWriter - the new value of the errorLogWriter property
+ * @param errorLogWriter - the new value of the errorLogWriter
property
*/
public void setErrorLogWriter(final PrintWriter errorLogWriter) {
this.errorLogWriter = errorLogWriter;
@@ -112,9 +112,9 @@ public void setErrorLogWriter(final PrintWriter errorLogWriter) {
*
* @param reader - the source of the script
*
- * @throws IOException DOCUMENT ME!
- * @throws SQLException DOCUMENT ME!
- * @throws RuntimeException DOCUMENT ME!
+ * @throws IOException if there is an error reading from the Reader
+ * @throws SQLException if any SQL errors occur
+ * @throws RuntimeException "Error running script. Cause: "
*/
public void runScript(final Reader reader) throws IOException, SQLException {
try {
@@ -289,11 +289,11 @@ private void runScript(final Connection conn, final Reader reader) throws IOExce
}
/**
- * DOCUMENT ME!
+ * Counts the "'" in the specified String
and tests whether the number is even or not.
*
- * @param s DOCUMENT ME!
+ * @param s String
which should be tested
*
- * @return DOCUMENT ME!
+ * @return True, if the Number is even.
*/
private boolean evenQuotes(final String s) {
int count = 0;
@@ -307,20 +307,20 @@ private boolean evenQuotes(final String s) {
}
/**
- * DOCUMENT ME!
+ * Gettter for delimiter
*
- * @return DOCUMENT ME!
+ * @return delimiter
*/
private String getDelimiter() {
return delimiter;
}
/**
- * DOCUMENT ME!
+ * If logWriter is Empty print the Object in System Console
*
* >>>>>>> .r4704
*
- * @param o DOCUMENT ME!
+ * @param o Object
which is going to be printed
*/
private void print(final Object o) {
if (logWriter != null) {
@@ -329,9 +329,9 @@ private void print(final Object o) {
}
/**
- * DOCUMENT ME!
+ * If logWriter is Empty print the Object in logWriter.Does a Line Break and flushes.
*
- * @param o DOCUMENT ME!
+ * @param o Object
which is going to be printed
*/
private void println(final Object o) {
if (logWriter != null) {
@@ -341,9 +341,9 @@ private void println(final Object o) {
}
/**
- * DOCUMENT ME!
+ * If errorLogWriter is Empty print the Object in errorLogWriter.Does a Line Break and flushes.
*
- * @param o DOCUMENT ME!
+ * @param o Object
which is going to be printed
*/
private void printlnError(final Object o) {
if (errorLogWriter != null) {
@@ -353,7 +353,7 @@ private void printlnError(final Object o) {
}
/**
- * DOCUMENT ME!
+ * Flushes the Streams
*/
private void flush() {
if (logWriter != null) {
diff --git a/src/main/java/de/cismet/tools/Sorter.java b/src/main/java/de/cismet/tools/Sorter.java
index dcb8e8c..c12053e 100644
--- a/src/main/java/de/cismet/tools/Sorter.java
+++ b/src/main/java/de/cismet/tools/Sorter.java
@@ -7,7 +7,7 @@
****************************************************/
package de.cismet.tools;
/**
- * DOCUMENT ME!
+ * Sorter Tool
*
* @version $Revision$, $Date$
*/
@@ -17,11 +17,11 @@ public class Sorter {
// -----------------------------------------------------------------------------------------------
/**
- * ueberpruft ob das array sortiert ist.
+ * Tests whether the specified Array
is sorted or not.
*
- * @param array DOCUMENT ME!
+ * @param array Array
, which is going to be tested.
*
- * @return DOCUMENT ME!
+ * @return True
, if the Array
is sorted.
*/
private static boolean isSorted(final Comparable[] array) {
if (array.length < 2) {
@@ -40,16 +40,24 @@ private static boolean isSorted(final Comparable[] array) {
}
/**
- * -------------------------------------------------------------------------------
+ * Sorts the specified Array
with insertionSort
. The Complete Array
is searched.
*
- * @param array DOCUMENT ME!
+ * @param array Array
, which is going to get sorted
+ *
+ * @see #insertionSort(java.lang.Comparable[], int, int)
*/
public static void insertionSort(final Comparable[] array) {
insertionSort(array, 0, array.length - 1);
}
- /**InsertionSort*/
-
+ /**
+ * Sorts the specified Array
with insertionSort
. Sorts only a specified area.
+ *
+ * @param array Array
, which is going to get sorted
+ * @param left left end of the area, which is going to get sorted
+ * @param right right end of the area, which is going to get sorted
+ *
+ */
public static void insertionSort(final Comparable[] array, final int left, final int right) {
int in;
int out;
@@ -71,12 +79,17 @@ public static void insertionSort(final Comparable[] array, final int left, final
//----------------------------------------------------------------------------------------------------------
/**
- * Quicksort welches bei der Unterschreitung von partitionsize auf InsertionSort umschaltet.
+ * Sorts the specified Array
with Quicksort
.Sorts only a specified area.
+ * If the to be sorted area is smaller than or equal partitionSize, InsertionSort
will be used.
*
- * @param array DOCUMENT ME!
- * @param left DOCUMENT ME!
- * @param right DOCUMENT ME!
- * @param partitionSize DOCUMENT ME!
+ * @param array Array
, which is going to get sorted.
+ * @param left left end of the area, which is going to get sorted
+ * @param right right end of the area, which is going to get sorted
+ * @param partitionSize minimal size for using Quicksort
+ *
+ * @see #insertionSort(java.lang.Comparable[], int, int)
+ * @see #partitionIt(java.lang.Comparable[], int, int, java.lang.Object)
+ * @see #swap(java.lang.Object[], int, int)
*/
private static void quickSort(final Comparable[] array, final int left, final int right, final int partitionSize) {
@@ -98,23 +111,32 @@ private static void quickSort(final Comparable[] array, final int left, final in
}
/**
- * ----------------------------------------------------------------------------------------------
+ * Sorts the specified Array
with Quicksort
.Sorts the complete Array
.
+ * If the to be sorted area is smaller than or equal 16, InsertionSort
will be used.
*
- * @param array DOCUMENT ME!
+ * @param array Array
, which is going to get sorted.
+ *
+ * @see #quickSort(java.lang.Comparable[], int, int, int)
*/
public static void quickSort(final Comparable[] array) {
quickSort(array, 0, array.length - 1, 16); // no insertion when partition >=16
}
/**
- * --------------------------------------------------------------------------- nimmt die unterteilung in die Mengen
- * S< u. S> vor wird von Quicksort verwendet*
+ * Divides into two Sets
+ *
+ * - all Elements which are smaller than the Rightmost
+ * - all Elements which are bigger than the Rightmost
+ *
*
- * @param array DOCUMENT ME!
- * @param left DOCUMENT ME!
- * @param right DOCUMENT ME!
- * @param pivot DOCUMENT ME!
+ * @param array Array, which is going to get Sorted
+ * @param left left end of the area, which is going to get sorted
+ * @param right right end of the area, which is going to get sorted
+ * @param pivot Rightmost
*
- * @return DOCUMENT ME!
+ * @return Location of the Rightmost after the Sorting
+ *
+ * @see #quickSort(java.lang.Comparable[], int, int, int)
+ * @see #swap(java.lang.Object[], int, int)
*/
private static int partitionIt(final Comparable[] array, final int left, final int right, final Object pivot) {
int leftPtr = left - 1;
@@ -144,11 +166,14 @@ private static int partitionIt(final Comparable[] array, final int left, final i
//----------------------------------------------------------------------------------------------
/**
- * tauscht 2 Elemente eines Arrays.
+ * swaps two Elements of the specified Array
*
- * @param array DOCUMENT ME!
- * @param i DOCUMENT ME!
- * @param j DOCUMENT ME!
+ * @param array Array
, which is going to get sorted
+ * @param i Location of Element one
+ * @param j Location of Element two
+ *
+ * @see #quickSort(java.lang.Comparable[], int, int, int)
+ * @see #partitionIt(java.lang.Comparable[], int, int, java.lang.Object)
*/
private static void swap(final Object[] array, final int i, final int j) {
diff --git a/src/main/java/de/cismet/tools/StaticDebuggingTools.java b/src/main/java/de/cismet/tools/StaticDebuggingTools.java
index 1cdd589..8160b2f 100644
--- a/src/main/java/de/cismet/tools/StaticDebuggingTools.java
+++ b/src/main/java/de/cismet/tools/StaticDebuggingTools.java
@@ -18,7 +18,7 @@
import java.io.File;
/**
- * DOCUMENT ME!
+ * StaticDebuggingTools
*
* @author cschmidt
* @version $Revision$, $Date$
@@ -36,11 +36,11 @@ public StaticDebuggingTools() {
//~ Methods ----------------------------------------------------------------
/**
- * �berpr�ft ob eine Datei mit dem �bergebenen Dateiname im Home-Verzeichnis des Users existiert.
+ * Tests whether the specified Filename exists in the User's Home Directory or not.
*
- * @param filename Name der gesuchten Datei.
+ * @param filename Filename of the searched File
*
- * @return DOCUMENT ME!
+ * @return True, if the Filename is contained in the Home Directory
*/
public static boolean checkHomeForFile(final String filename) {
try {
diff --git a/src/main/java/de/cismet/tools/StaticDecimalTools.java b/src/main/java/de/cismet/tools/StaticDecimalTools.java
index 8d1b379..6da4fb5 100644
--- a/src/main/java/de/cismet/tools/StaticDecimalTools.java
+++ b/src/main/java/de/cismet/tools/StaticDecimalTools.java
@@ -8,7 +8,7 @@
package de.cismet.tools;
/**
- * DOCUMENT ME!
+ * StaticDecimalTools. Rounds Double
.
*
* @author thorsten.hell@cismet.de
* @version $Revision$, $Date$
@@ -18,22 +18,24 @@ public class StaticDecimalTools {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * Rounds Doubles to the Form "0.00"
*
- * @param d DOCUMENT ME!
+ * @param d Double
which should be rounded
*
- * @return DOCUMENT ME!
+ * @return the rounded Double
+ *
+ * @see #round(java.lang.String, double)
*/
public static String round(final double d) {
return round("0.00", d); // NOI18N
}
/**
- * DOCUMENT ME!
+ * Rounds the Doubles to a specified Form.
*
- * @param pattern DOCUMENT ME!
- * @param d DOCUMENT ME!
+ * @param pattern Form of the rounded Double
as String
+ * @param d Double
which should be rounded
*
- * @return DOCUMENT ME!
+ * @return the rounded Double
*/
public static String round(final String pattern, final double d) {
final double dd = ((double)(Math.round(d * 100))) / 100;
diff --git a/src/main/java/de/cismet/tools/StaticHtmlTools.java b/src/main/java/de/cismet/tools/StaticHtmlTools.java
index 21292ec..390f31d 100644
--- a/src/main/java/de/cismet/tools/StaticHtmlTools.java
+++ b/src/main/java/de/cismet/tools/StaticHtmlTools.java
@@ -12,7 +12,7 @@
import java.net.URLEncoder;
/**
- * DOCUMENT ME!
+ * StaticHtmlTools
*
* @author thorsten.hell@cismet.de
* @version $Revision$, $Date$
@@ -22,11 +22,11 @@ public class StaticHtmlTools {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * converts HTTPReferences.
*
- * @param newString DOCUMENT ME!
+ * @param newString link
*
- * @return DOCUMENT ME!
+ * @return HTTPReference
*/
public static String convertHTTPReferences(String newString) {
int hrefStartPos;
@@ -95,11 +95,11 @@ public static String convertHTTPReferences(String newString) {
}
/**
- * DOCUMENT ME!
+ * Strips Meta Tag.
*
- * @param text DOCUMENT ME!
+ * @param text String
*
- * @return DOCUMENT ME!
+ * @return Meta Tag
*/
public static String stripMetaTag(final String text) {
// String used for searching, comparison and indexing
@@ -122,9 +122,9 @@ public static String stripMetaTag(final String text) {
}
/**
- * DOCUMENT ME!
+ * main
*
- * @param args DOCUMENT ME!
+ * @param args args
*/
public static void main(final String[] args) {
final String test = "test http://www.google.de?quiery wer"; // NOI18N
@@ -133,11 +133,11 @@ public static void main(final String[] args) {
}
/**
- * DOCUMENT ME!
+ * Converts the specified String
into a HTMLString
.
*
- * @param string DOCUMENT ME!
+ * @param string String
, which is going to get converted
*
- * @return DOCUMENT ME!
+ * @return HTMLString
*/
public static String stringToHTMLString(final String string) {
if (string == null) {
@@ -197,11 +197,11 @@ public static String stringToHTMLString(final String string) {
}
/**
- * DOCUMENT ME!
+ * Encodes the specified String
into UTF-8 Format.
*
- * @param parameter DOCUMENT ME!
+ * @param parameter String
, which is going to be encoded
*
- * @return DOCUMENT ME!
+ * @return encoded String
*/
public static String encodeURLParameter(final String parameter) {
try {
diff --git a/src/main/java/de/cismet/tools/StaticXMLTools.java b/src/main/java/de/cismet/tools/StaticXMLTools.java
index d501709..688dab2 100644
--- a/src/main/java/de/cismet/tools/StaticXMLTools.java
+++ b/src/main/java/de/cismet/tools/StaticXMLTools.java
@@ -17,7 +17,7 @@
import java.awt.Font;
/**
- * DOCUMENT ME!
+ * Static XML Tools
*
* @author thorsten
* @version $Revision$, $Date$
@@ -39,9 +39,9 @@ private StaticXMLTools() {
//~ Methods ----------------------------------------------------------------
/**
- * Konvertiert eine Farbe zu folgendem XML-Code .
+ * Converts a Color
into XML-Code .
*
- * @param c die in XML darzustellende Farbe
+ * @param c Color
, which is going to be converted
*
* @return JDOM-Element
*/
@@ -55,11 +55,11 @@ public static Element convertColorToXML(final Color c) {
}
/**
- * DOCUMENT ME!
+ * Converts the specified XMLElement
into a Color
*
- * @param xmlElement DOCUMENT ME!
+ * @param xmlElement xmlElemt
, which is going to be converted
*
- * @return DOCUMENT ME!
+ * @return Color
*/
public static Color convertXMLElementToColor(final Element xmlElement) {
int red = 0;
@@ -89,9 +89,9 @@ public static Color convertXMLElementToColor(final Element xmlElement) {
}
/**
- * Konvertiert eine Schrift zu folgendem XML-Code.
+ * Converts the Font
into XML-Code
*
- * @param f die zu konvertierende Schrift
+ * @param f Font
, which is going to be converted
*
* @return JDOM-Element
*/
@@ -104,11 +104,11 @@ public static Element convertFontToXML(final Font f) {
}
/**
- * DOCUMENT ME!
+ * Converts XMLElement
into Font
*
- * @param xmlElement DOCUMENT ME!
+ * @param xmlElement xmlElement
, which is going to be converted
*
- * @return DOCUMENT ME!
+ * @return Font
*/
public static Font convertXMLElementToFont(final Element xmlElement) {
String name = "sansserif"; // NOI18N
@@ -132,9 +132,9 @@ public static Font convertXMLElementToFont(final Element xmlElement) {
}
/**
- * DOCUMENT ME!
+ * Posts the specified XML on the Logger.
*
- * @param element DOCUMENT ME!
+ * @param element XML, which is going to be posted
*/
public static void logXML(final Element element) {
final Document doc = new Document();
diff --git a/src/main/java/de/cismet/tools/StringTools.java b/src/main/java/de/cismet/tools/StringTools.java
index d83f802..605eeb9 100644
--- a/src/main/java/de/cismet/tools/StringTools.java
+++ b/src/main/java/de/cismet/tools/StringTools.java
@@ -13,7 +13,7 @@
package de.cismet.tools;
/**
- * DOCUMENT ME!
+ * String Tools
*
* @author schlob
* @version $Revision$, $Date$
@@ -31,11 +31,11 @@ private StringTools() {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * Deletes Whitspaces in the String
*
- * @param string DOCUMENT ME!
+ * @param string String
, which is going to get cleaned
*
- * @return DOCUMENT ME!
+ * @return cleaned String
*/
public static String deleteWhitespaces(final String string) {
if (string == null) {
From d253a44dee2f520069eaf97f542fe2a7474ce24b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Mon, 7 Jan 2013 18:03:50 +0100
Subject: [PATCH 10/34] #9 Java Doc Improvements of Package de.cismet.tools
---
src/main/java/de/cismet/tools/Base64.java | 2 +-
.../java/de/cismet/tools/BrowserLauncher.java | 13 +++++--
.../de/cismet/tools/CalculationCache.java | 16 ++++----
.../java/de/cismet/tools/ConnectionInfo.java | 2 +-
src/main/java/de/cismet/tools/Equals.java | 3 +-
src/main/java/de/cismet/tools/FileUtils.java | 38 +++++++++----------
.../cismet/tools/PropertyEqualsProvider.java | 2 +-
.../java/de/cismet/tools/TextFromFile.java | 8 ++--
.../java/de/cismet/tools/TimeoutThread.java | 6 +--
.../java/de/cismet/tools/URLSplitter.java | 34 +++++++++++------
10 files changed, 70 insertions(+), 54 deletions(-)
diff --git a/src/main/java/de/cismet/tools/Base64.java b/src/main/java/de/cismet/tools/Base64.java
index a74dae2..6ec825e 100644
--- a/src/main/java/de/cismet/tools/Base64.java
+++ b/src/main/java/de/cismet/tools/Base64.java
@@ -57,7 +57,7 @@ private Base64() {
*
* @return the base64 encoded input array
*
- * @throws IllegalArgumentException DOCUMENT ME!
+ * @throws IllegalArgumentException if the given array is of length null
*/
public static byte[] toBase64(final byte[] byteString, final boolean wipeInput) {
if (byteString == null) {
diff --git a/src/main/java/de/cismet/tools/BrowserLauncher.java b/src/main/java/de/cismet/tools/BrowserLauncher.java
index 6c28b71..bc4bb8d 100644
--- a/src/main/java/de/cismet/tools/BrowserLauncher.java
+++ b/src/main/java/de/cismet/tools/BrowserLauncher.java
@@ -460,7 +460,8 @@ private static Object locateBrowser() {
}
/**
- * DOCUMENT ME!
+ * Attempts to open the default web browser to the gieven URL.
+ * In the second attempt he tries to open the url as a file.
*
* @param url DOCUMENT ME!
*/
@@ -488,8 +489,14 @@ public static void openURLorFile(final String url) {
*
* @param url The URL to open
*
- * @throws Exception DOCUMENT ME!
- * @throws IOException If the web browser could not be located or does not run
+ * @throws Exception
+ * @throws IOException
+ *
+ * - If the web browser could not be located or does not run
+ * - If it catches a
InvocationTargetException
+ * - If it catches a
IllegalAccessExeption
+ * - if it catches a
InstantiationException
+ *
*/
public static void openURL(final String url) throws Exception {
if (log.isDebugEnabled()) {
diff --git a/src/main/java/de/cismet/tools/CalculationCache.java b/src/main/java/de/cismet/tools/CalculationCache.java
index ac676ff..1d16ee6 100644
--- a/src/main/java/de/cismet/tools/CalculationCache.java
+++ b/src/main/java/de/cismet/tools/CalculationCache.java
@@ -49,11 +49,11 @@ public CalculationCache(final Calculator calc) {
/**
* Calculates the value for the given key, if required and caches it.
*
- * @param key link query DOCUMENT ME!
+ * @param key link query
*
- * @return DOCUMENT ME!
+ * @return value
*
- * @throws Exception DOCUMENT ME!
+ * @throws Exception if any Exception
is in {@link #exceptionCache}
*/
public VALUE calcValue(final KEY key) throws Exception {
VALUE result = cache.get(key);
@@ -118,9 +118,9 @@ public void run() {
}
/**
- * DOCUMENT ME!
+ * Get the time in milliseconds, the result should be cached
*
- * @return the time in milliseconds, the result should be cached
+ * @return the time in milliseconds
*/
public long getTimeToCacheResults() {
return timeToCacheResults;
@@ -136,10 +136,10 @@ public void setTimeToCacheResults(final long timeToCacheResults) {
}
/**
- * DOCUMENT ME!
- *
- * @return the time in milliseconds, exceptions, which were thrown during the calculation of a value, should be
+ * get the time in milliseconds, exceptions, which were thrown during the calculation of a value, should be
* cached
+ *
+ * @return the time in milliseconds
*/
public long getTimeToCacheExceptions() {
return timeToCacheExceptions;
diff --git a/src/main/java/de/cismet/tools/ConnectionInfo.java b/src/main/java/de/cismet/tools/ConnectionInfo.java
index 734941e..39b5b38 100644
--- a/src/main/java/de/cismet/tools/ConnectionInfo.java
+++ b/src/main/java/de/cismet/tools/ConnectionInfo.java
@@ -90,7 +90,7 @@ public void setUrl(final String url) {
/**
* Getter for User.
*
- * @return DB USer
+ * @return DB User
*/
public String getUser() {
return user;
diff --git a/src/main/java/de/cismet/tools/Equals.java b/src/main/java/de/cismet/tools/Equals.java
index 20468fd..dd55d6f 100644
--- a/src/main/java/de/cismet/tools/Equals.java
+++ b/src/main/java/de/cismet/tools/Equals.java
@@ -35,7 +35,7 @@ private Equals() {
* @param o object one
* @param o2 object two
*
- * @return true, if obeject one and object two deliver the same result for every bean getter
+ * @return true, if object one and object two deliver the same result for every bean getter
*
* @see #beanDeepEqual(java.lang.Object, java.lang.Object, java.lang.String[])
*/
@@ -117,7 +117,6 @@ private static boolean contains(final String name, final String... array) {
* - is not static
* - name starts with 'get' (or 'is' for
boolean
getters)
* - there exists a field with a corresponding name
- *
*
*
* @param m given method
diff --git a/src/main/java/de/cismet/tools/FileUtils.java b/src/main/java/de/cismet/tools/FileUtils.java
index 691c6b0..347062c 100644
--- a/src/main/java/de/cismet/tools/FileUtils.java
+++ b/src/main/java/de/cismet/tools/FileUtils.java
@@ -53,7 +53,7 @@ private FileUtils() {
//~ Methods ----------------------------------------------------------------
/**
- * Checks whether the File
is a MetaFiles
or not
+ * Tests whether the specified File
is a MetaFiles
or not
*
* @param check File
to be tested
*
@@ -66,7 +66,7 @@ public static boolean isMetaFile(final File check) {
}
/**
- * Checks whether the File
is a MetaFile
of the tested OS
or not
+ * Tests whether the specified File
is a MetaFile
of the tested OS
or not
*
* @param check File
to be tested
* @param mode Number of OS
to be tested
@@ -78,7 +78,7 @@ public static boolean isMetaFile(final File check, final int mode) {
}
/**
- * get the MetaEntries
for the Meta
+ * Getter for MetaEntries
of the specified Meta
*
* @param mode Metanumber
*
@@ -118,7 +118,7 @@ private static String[] getMetaEntries(final int mode) {
}
/**
- * Checks whether the File
has the Metaentries
or not
+ * Tests whether the specified File
has the specified Metaentries
or not
*
* @param filename name of the tested File
* @param meta Metaentries
to be tested
@@ -153,7 +153,7 @@ private static int getMode() {
}
/**
- * Getter for the name of the File
+ * Getter for the name of the specified File
*
* @param file given File
*
@@ -170,7 +170,7 @@ public static String getName(final File file) {
}
/**
- * Getter for the Filestype
+ * Getter for the Filestype of the specified File
*
* @param file given file
*
@@ -187,7 +187,7 @@ public static String getExt(final File file) {
}
/**
- * Tests whether the File
only contains MetaFiles
or not
+ * Tests whether the specified File
only contains MetaFiles
of one type or not
*
* @param check File
to be tested
*
@@ -200,9 +200,9 @@ public static boolean containsOnlyMetaFiles(final File check) {
}
/**
- * Tests whether the Directory
only contains MetaFiles
of the given OS
+ * Tests whether the specified Directory
only contains MetaFiles
of the specified OS
*
- * @param check File
to be tested
+ * @param check Directory/code> to be tested
* @param mode Os
*
* @return true, if it only contains MetaFiles
of the tested Os
@@ -225,7 +225,7 @@ public static boolean containsOnlyMetaFiles(final File check, final int mode) {
return true;
}
/**
- * Copies the File
+ * Copies the specified File
* Note: exception thrown and not handled to avoid logger call if it is necessary to use logger in this class return
* boolean and handle exceptions.
*
@@ -258,7 +258,7 @@ public static void copyFile(final File inFile, final File outFile) throws FileNo
}
/**
- * Copys the Directory
. It uses the a filtered list of Files
contained inside the Directory
. If there is any Directory
the Method
starts recursive
+ * Copies the Content of the specified Directory
. It uses {@link FilesFilter}. If it is a File
, it copies the File and if it is a Directory
, the methode start recursive again with the found Directory
Directory
.
*
- * @param srcDir given Directory
+ * @param srcDir Directory
* @param recursive recursive
*
* @throws IOException IOException
@@ -442,7 +442,7 @@ public static void extractJar(final File jar, final File dest, final FileFilter
//~ Inner Classes ----------------------------------------------------------
/**
- * Inner Class JarFilter
+ * Filter for searching for .jar Files
*
* @version $Revision$, $Date$
*/
@@ -464,7 +464,7 @@ public boolean accept(final File file) {
}
/**
- * Inner Class DirandJarFilter
+ * Filter for searching for .jar Files and Directories
*
* @version $Revision$, $Date$
*/
@@ -486,7 +486,7 @@ public boolean accept(final File file) {
}
/**
- * Inner Class DirectoryFilter
+ * Filter for searching for Directories
*
* @version $Revision$, $Date$
*/
@@ -509,7 +509,7 @@ public boolean accept(final File file) {
}
/**
- * Inner Class FilesFilter
+ * Filter for searching for Files
*
* @version $Revision$, $Date$
*/
@@ -522,7 +522,7 @@ public static final class FilesFilter implements FileFilter {
*
* @param file given File
*
- * @return true, if the File
is a Directory
+ * @return true, if the File
is Not! a Directory
, false if it is a Directory
*/
@Override
@@ -532,7 +532,7 @@ public boolean accept(final File file) {
}
/**
- * Inner Class MetaInfFilter
+ * Filter for searching for MetaFiles
*
* @version $Revision$, $Date$
*/
diff --git a/src/main/java/de/cismet/tools/PropertyEqualsProvider.java b/src/main/java/de/cismet/tools/PropertyEqualsProvider.java
index 24f223a..5a7271a 100644
--- a/src/main/java/de/cismet/tools/PropertyEqualsProvider.java
+++ b/src/main/java/de/cismet/tools/PropertyEqualsProvider.java
@@ -24,7 +24,7 @@
package de.cismet.tools;
/**
- * Property Equals Provideer
+ * Property Equals Provider
*
* @author thorsten
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/TextFromFile.java b/src/main/java/de/cismet/tools/TextFromFile.java
index 0c5e344..5b70dd2 100644
--- a/src/main/java/de/cismet/tools/TextFromFile.java
+++ b/src/main/java/de/cismet/tools/TextFromFile.java
@@ -11,7 +11,7 @@
import java.util.*;
/**
- * DOCUMENT ME!
+ * Class for getting Text from File
*
* @version $Revision$, $Date$
*/
@@ -26,16 +26,16 @@ public class TextFromFile {
//~ Constructors -----------------------------------------------------------
/**
- * /////////////////////////////////////////
+ * Creates a Default TextFromFile object.
*/
public TextFromFile() {
data = new byte[0];
}
/**
- * ///////////////////////////////////////////
+ * Creates a new TextFromFile object from file
with specified filepath
*
- * @param filepath DOCUMENT ME!
+ * @param filepath filepath
*/
public TextFromFile(final String filepath) {
try {
diff --git a/src/main/java/de/cismet/tools/TimeoutThread.java b/src/main/java/de/cismet/tools/TimeoutThread.java
index f65b399..5098171 100644
--- a/src/main/java/de/cismet/tools/TimeoutThread.java
+++ b/src/main/java/de/cismet/tools/TimeoutThread.java
@@ -45,10 +45,10 @@ public TimeoutThread() {
*
* @param timeInMillis the time to wait in milliseconds
*
- * @return DOCUMENT ME
+ * @return result
*
- * @throws Exception DOCUMENT ME!
- * @throws TimeoutException DOCUMENT ME!
+ * @throws Exception
+ * @throws TimeoutException
*/
public T start(final long timeInMillis) throws Exception {
final Thread t = new Thread(this);
diff --git a/src/main/java/de/cismet/tools/URLSplitter.java b/src/main/java/de/cismet/tools/URLSplitter.java
index 4fa5be6..7a093c3 100644
--- a/src/main/java/de/cismet/tools/URLSplitter.java
+++ b/src/main/java/de/cismet/tools/URLSplitter.java
@@ -8,7 +8,7 @@
package de.cismet.tools;
/**
- * DOCUMENT ME!
+ * Urlsplitter
*
* @author thorsten.hell@cismet.de
* @version $Revision$, $Date$
@@ -27,7 +27,7 @@ public class URLSplitter {
/**
* Creates a new URLSplitter object.
*
- * @param url DOCUMENT ME!
+ * @param url given url
*/
public URLSplitter(final String url) {
// Versuch den Protokoll Prefix zu f\u00FCllen
@@ -85,41 +85,51 @@ private URLSplitter() {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * Getter for prot_prefix
*
- * @return DOCUMENT ME!
+ * @return prot_prefix
*/
public String getProt_prefix() {
return prot_prefix;
}
/**
- * DOCUMENT ME!
+ * Getter for server
*
- * @return DOCUMENT ME!
+ * @return server
*/
public String getServer() {
return server;
}
/**
- * DOCUMENT ME!
+ * Getter for path
*
- * @return DOCUMENT ME!
+ * @return path
*/
public String getPath() {
return path;
}
/**
- * DOCUMENT ME!
+ * Getter for object_name
*
- * @return DOCUMENT ME!
+ * @return object_name
*/
public String getObject_name() {
return object_name;
}
+ /**
+ * returns a String
, which has the following form
+ * Prot: {@link #prot_prefix}
+ * Server: {@link #server}
+ * Path: {@link #path}
+ * Objekt: {@link #object_name}
+ *
+ * @return String
+ */
+
@Override
public String toString() {
return "Prot: " + prot_prefix + "\n" // NOI18N
@@ -129,9 +139,9 @@ public String toString() {
}
/**
- * DOCUMENT ME!
+ * main
*
- * @param args DOCUMENT ME!
+ * @param args args
*/
public static void main(final String[] args) {
System.out.println("\n" + new URLSplitter("http://www.google.de/")); // NOI18N
From b065b91fcb64138b5f9123637ee8c8ddc2763be5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Tue, 8 Jan 2013 11:30:10 +0100
Subject: [PATCH 11/34] #9 Java Doc Improvements of package
Sirius.util.collections
---
.../util/collections/IntMapsString.java | 24 ++++++++-----
.../Sirius/util/collections/MultiMap.java | 34 +++++++++----------
.../util/collections/StringMapsInt.java | 26 +++++++++-----
.../util/collections/StringMapsString.java | 24 +++++++++----
.../util/collections/SyncLinkedList.java | 2 +-
5 files changed, 68 insertions(+), 42 deletions(-)
diff --git a/src/main/java/Sirius/util/collections/IntMapsString.java b/src/main/java/Sirius/util/collections/IntMapsString.java
index d8aee54..8fc719b 100644
--- a/src/main/java/Sirius/util/collections/IntMapsString.java
+++ b/src/main/java/Sirius/util/collections/IntMapsString.java
@@ -7,8 +7,14 @@
****************************************************/
package Sirius.util.collections;
+import java.util.Hashtable;
+
/**
- * DOCUMENT ME!
+ * Modified {@link Hashtable}, which maps Integer
to String
.
+ *
+ * Key
- Integer
+ * Value
- String
+ *
*
* @version $Revision$, $Date$
*/
@@ -28,6 +34,8 @@ public class IntMapsString extends java.util.Hashtable {
*
* @param initialCapacity Capacity when Object is created
* @param loadFactor buffer for capacity increase
+ *
+ * @see Hashtable
*/
IntMapsString(final int initialCapacity, final float loadFactor) {
super(initialCapacity, loadFactor);
@@ -36,19 +44,19 @@ public class IntMapsString extends java.util.Hashtable {
//~ Methods ----------------------------------------------------------------
/**
- * Associates a String
astring(value) to a Integery
id(key).
+ * Associates a Integer
id(key) to a String
astring(value).
*
* @param id key
* @param aString value
- *
- * @see #put(java.lang.Object, java.lang.Object)
+ *
+ * @see #put(java.lang.Object, java.lang.Object)
*/
public void add(final int id, final String aString) {
super.put(new Integer(id), aString);
} // end add
/**
- * Getter for the Value as a String
+ * Getter for the Value as a String.
*
* @param id key
*
@@ -75,13 +83,13 @@ public String getStringValue(final int id) throws Exception {
// when exception concept is accomplished
}
/**
- * Tests if the specified object is a key in IntMapsString
+ * Tests whether the specified object is a key in IntMapsString
or not.
*
* @param key possible key
*
* @return true
, if the object is a key in IntMapsString
- *
- * @see #containsKey(java.lang.Object)
+ *
+ * @see #containsKey(java.lang.Object)
*/
public boolean containsIntKey(final int key) {
return super.containsKey(new Integer(key));
diff --git a/src/main/java/Sirius/util/collections/MultiMap.java b/src/main/java/Sirius/util/collections/MultiMap.java
index 98367dc..c91db5c 100644
--- a/src/main/java/Sirius/util/collections/MultiMap.java
+++ b/src/main/java/Sirius/util/collections/MultiMap.java
@@ -9,6 +9,8 @@
import java.util.*;
/**
+ * Modified {@link HashMap}, which makes it possible to map Keys to multiple Values.
+ *
* //key=idnetifier;value=LinkedList.
*
* @version $Revision$, $Date$
@@ -24,7 +26,7 @@ public MultiMap() {
this(10);
}
/**
- * Creates new Multimap Object with chosen size.
+ * Creates new Multimap Object with specified size.
*
* @param size size
*/
@@ -35,17 +37,17 @@ public MultiMap(final int size) {
//~ Methods ----------------------------------------------------------------
/////////////////////////////////////////////////
-
+
/**
- * Assosiates value
with key
in this map
.
- * Instead of replace the values for a key, are multiple values for one key possible.
- *
- * @param key key
- * @param value value
- *
- * @return Null
+ * Assosiates value
with key
in this map
. Instead of replace the previous value for a
+ * key,it is possible to have multiple values for one key possible.
+ *
+ * @param key key
+ * @param value value
+ *
+ * @return Null
*/
-
+
@Override
public Object put(final Object key, final Object value) {
SyncLinkedList list = null;
@@ -70,12 +72,10 @@ public Object put(final Object key, final Object value) {
//////////////////////////////////////////////////////////////
/**
- * Appends the values of the specified map
to this map
.
- * Instead of replace the values for a key, are multiple values for one key possible.
- *
- *
- *
- * @param t map
+ * Appends the values of the specified map
to this map
. Instead of replace the previous value for
+ * a key, it is possible multiple values for one key possible.
+ *
+ * @param t map
*/
@Override
@@ -102,7 +102,7 @@ public void putAll(final Map t) {
}
/**
- * removes specied value
associeated with specified key
+ * Removes specified value
associeated with specified key.
*
* @param key key whose mapping is to be removed
* @param value mapping to be removed
diff --git a/src/main/java/Sirius/util/collections/StringMapsInt.java b/src/main/java/Sirius/util/collections/StringMapsInt.java
index 4f60b9e..ecf0996 100644
--- a/src/main/java/Sirius/util/collections/StringMapsInt.java
+++ b/src/main/java/Sirius/util/collections/StringMapsInt.java
@@ -7,8 +7,14 @@
****************************************************/
package Sirius.util.collections;
+import java.util.Hashtable;
+
/**
- * DOCUMENT ME!
+ * Modified {@link Hashtable}, which maps String
to Integer
.
+ *
+ * Key
- String
+ * Value
- Integer
+ *
*
* @version $Revision$, $Date$
*/
@@ -28,6 +34,8 @@ public StringMapsInt() {
*
* @param initialCapacity Capacity when Object is created
* @param loadFactor buffer for capacity increase
+ *
+ * @see Hashtable
*/
public StringMapsInt(final int initialCapacity, final float loadFactor) {
super(initialCapacity, loadFactor);
@@ -40,21 +48,21 @@ public StringMapsInt(final int initialCapacity, final float loadFactor) {
*
* @param descriptor key
* @param sqlID value
- *
- * @see #put(java.lang.Object, java.lang.Object)
+ *
+ * @see #put(java.lang.Object, java.lang.Object)
*/
public void add(final String descriptor, final int sqlID) {
super.put(descriptor, new Integer(sqlID));
} // end add
/**
- * Getter for the Value as a Integer
+ * Getter for the Value as a Integer.
*
* @param descriptor descriptor
*
* @return IntValue
*
- * @throws Exception DOCUMENT ME!
+ * @throws Exception
* @throws java.lang.NullPointerException "Entry is not a Integer" or "No entry"
*/
public int getIntValue(final String descriptor) throws Exception {
@@ -73,13 +81,13 @@ public int getIntValue(final String descriptor) throws Exception {
// accomplished
}
/**
- * Tests if the specified object is a key in StringMapsInt
+ * Tests whether the specified object is a key in StringMapsInt
or not.
*
- * @param key possible key
+ * @param key possible key
*
* @return true
, if the object is a key in StringMapsInt
- *
- * @see #containsKey(java.lang.Object)
+ *
+ * @see #containsKey(java.lang.Object)
*/
public boolean containsStringKey(final String key) {
return super.containsKey(key);
diff --git a/src/main/java/Sirius/util/collections/StringMapsString.java b/src/main/java/Sirius/util/collections/StringMapsString.java
index cef61cb..a5ee94d 100644
--- a/src/main/java/Sirius/util/collections/StringMapsString.java
+++ b/src/main/java/Sirius/util/collections/StringMapsString.java
@@ -7,8 +7,14 @@
****************************************************/
package Sirius.util.collections;
+import java.util.Hashtable;
+
/**
- * renames.
+ * Modified {@link Hashtable}, which maps String
to String
.
+ *
+ * Key
- String
+ * Value
- String
+ *
*
* @version $Revision$, $Date$
*/
@@ -17,7 +23,7 @@ public class StringMapsString extends java.util.Hashtable {
//~ Constructors -----------------------------------------------------------
/**
- * Creates a new StringMapString object
+ * Creates a new StringMapString object.
*/
public StringMapsString() {
super();
@@ -27,6 +33,8 @@ public StringMapsString() {
* Creates a new StringMapsString object.
*
* @param initialCapacity Capacity when Object is created
+ *
+ * @see Hashtable
*/
public StringMapsString(final int initialCapacity) {
super(initialCapacity);
@@ -37,6 +45,8 @@ public StringMapsString(final int initialCapacity) {
*
* @param initialCapacity Capacity when Object is created
* @param loadFactor buffer for capacity increase
+ *
+ * @see Hashtable
*/
public StringMapsString(final int initialCapacity, final float loadFactor) {
super(initialCapacity, loadFactor);
@@ -61,13 +71,13 @@ public void add(final String descriptor, final String aString) throws Exception
} // end add
/**
- * Getter for the Value as a String
+ * Getter for the Value as a String.
*
* @param descriptor key
*
* @return StringValue
*
- * @throws Exception
+ * @throws Exception DOCUMENT ME!
* @throws java.lang.NullPointerException "Entry is no String" or "No Entry"
*/
public String getStringValue(final String descriptor) throws Exception {
@@ -84,13 +94,13 @@ public String getStringValue(final String descriptor) throws Exception {
throw new java.lang.NullPointerException("No entry :" + descriptor); // NOI18N
}
/**
- * Tests if the specified object is a key in StringMapsString
+ * Tests whether the specified object is a key in StringMapsString
or not
*
* @param key possible key
*
* @return true
, if the object is a key in StringMapsString
- *
- * @see #containsKey(java.lang.Object)
+ *
+ * @see #containsKey(java.lang.Object)
*/
public boolean containsStringKey(final String key) {
return super.containsKey(key);
diff --git a/src/main/java/Sirius/util/collections/SyncLinkedList.java b/src/main/java/Sirius/util/collections/SyncLinkedList.java
index 4184d81..b20e6d1 100644
--- a/src/main/java/Sirius/util/collections/SyncLinkedList.java
+++ b/src/main/java/Sirius/util/collections/SyncLinkedList.java
@@ -14,7 +14,7 @@
import java.util.*;
/**
- * DOCUMENT ME!
+ * Modified {@link LinkedList} for synchronisation
*
* @author schlob
* @version $Revision$, $Date$
From 05a9821c22fa90787a66fce613d07ddb5f04d7e3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Tue, 8 Jan 2013 14:08:42 +0100
Subject: [PATCH 12/34] #9 Java Doc Improvements of package
Sirius.util.collections
---
.../Sirius/util/collections/IntMapsString.java | 9 +++++----
.../java/Sirius/util/collections/MultiMap.java | 12 ++++++------
.../Sirius/util/collections/StringMapsInt.java | 11 ++++++-----
.../Sirius/util/collections/StringMapsString.java | 15 ++++++++-------
.../Sirius/util/collections/SyncLinkedList.java | 2 +-
5 files changed, 26 insertions(+), 23 deletions(-)
diff --git a/src/main/java/Sirius/util/collections/IntMapsString.java b/src/main/java/Sirius/util/collections/IntMapsString.java
index 8fc719b..f20eda3 100644
--- a/src/main/java/Sirius/util/collections/IntMapsString.java
+++ b/src/main/java/Sirius/util/collections/IntMapsString.java
@@ -11,9 +11,10 @@
/**
* Modified {@link Hashtable}, which maps Integer
to String
.
+ *
*
- * Key
- Integer
- * Value
- String
+ * Key
- Integer
+ * Value
- String
*
*
* @version $Revision$, $Date$
@@ -34,8 +35,8 @@ public class IntMapsString extends java.util.Hashtable {
*
* @param initialCapacity Capacity when Object is created
* @param loadFactor buffer for capacity increase
- *
- * @see Hashtable
+ *
+ * @see Hashtable
*/
IntMapsString(final int initialCapacity, final float loadFactor) {
super(initialCapacity, loadFactor);
diff --git a/src/main/java/Sirius/util/collections/MultiMap.java b/src/main/java/Sirius/util/collections/MultiMap.java
index c91db5c..0d84141 100644
--- a/src/main/java/Sirius/util/collections/MultiMap.java
+++ b/src/main/java/Sirius/util/collections/MultiMap.java
@@ -10,8 +10,8 @@
import java.util.*;
/**
* Modified {@link HashMap}, which makes it possible to map Keys to multiple Values.
- *
- * //key=idnetifier;value=LinkedList.
+ *
+ * //key=idnetifier;value=LinkedList.
*
* @version $Revision$, $Date$
*/
@@ -39,8 +39,8 @@ public MultiMap(final int size) {
/////////////////////////////////////////////////
/**
- * Assosiates value
with key
in this map
. Instead of replace the previous value for a
- * key,it is possible to have multiple values for one key possible.
+ * Assosiates value
with key
in this map
. Instead of replace the previous
+ * value for a key,it is possible to have multiple values for one key possible.
*
* @param key key
* @param value value
@@ -72,8 +72,8 @@ public Object put(final Object key, final Object value) {
//////////////////////////////////////////////////////////////
/**
- * Appends the values of the specified map
to this map
. Instead of replace the previous value for
- * a key, it is possible multiple values for one key possible.
+ * Appends the values of the specified map
to this map
. Instead of replace the previous
+ * value for a key, it is possible multiple values for one key possible.
*
* @param t map
*/
diff --git a/src/main/java/Sirius/util/collections/StringMapsInt.java b/src/main/java/Sirius/util/collections/StringMapsInt.java
index ecf0996..f0f3027 100644
--- a/src/main/java/Sirius/util/collections/StringMapsInt.java
+++ b/src/main/java/Sirius/util/collections/StringMapsInt.java
@@ -11,9 +11,10 @@
/**
* Modified {@link Hashtable}, which maps String
to Integer
.
+ *
*
- * Key
- String
- * Value
- Integer
+ * Key
- String
+ * Value
- Integer
*
*
* @version $Revision$, $Date$
@@ -34,8 +35,8 @@ public StringMapsInt() {
*
* @param initialCapacity Capacity when Object is created
* @param loadFactor buffer for capacity increase
- *
- * @see Hashtable
+ *
+ * @see Hashtable
*/
public StringMapsInt(final int initialCapacity, final float loadFactor) {
super(initialCapacity, loadFactor);
@@ -62,7 +63,7 @@ public void add(final String descriptor, final int sqlID) {
*
* @return IntValue
*
- * @throws Exception
+ * @throws Exception DOCUMENT ME!
* @throws java.lang.NullPointerException "Entry is not a Integer" or "No entry"
*/
public int getIntValue(final String descriptor) throws Exception {
diff --git a/src/main/java/Sirius/util/collections/StringMapsString.java b/src/main/java/Sirius/util/collections/StringMapsString.java
index a5ee94d..a8b19b1 100644
--- a/src/main/java/Sirius/util/collections/StringMapsString.java
+++ b/src/main/java/Sirius/util/collections/StringMapsString.java
@@ -11,9 +11,10 @@
/**
* Modified {@link Hashtable}, which maps String
to String
.
+ *
*
- * Key
- String
- * Value
- String
+ * Key
- String
+ * Value
- String
*
*
* @version $Revision$, $Date$
@@ -33,8 +34,8 @@ public StringMapsString() {
* Creates a new StringMapsString object.
*
* @param initialCapacity Capacity when Object is created
- *
- * @see Hashtable
+ *
+ * @see Hashtable
*/
public StringMapsString(final int initialCapacity) {
super(initialCapacity);
@@ -45,8 +46,8 @@ public StringMapsString(final int initialCapacity) {
*
* @param initialCapacity Capacity when Object is created
* @param loadFactor buffer for capacity increase
- *
- * @see Hashtable
+ *
+ * @see Hashtable
*/
public StringMapsString(final int initialCapacity, final float loadFactor) {
super(initialCapacity, loadFactor);
@@ -94,7 +95,7 @@ public String getStringValue(final String descriptor) throws Exception {
throw new java.lang.NullPointerException("No entry :" + descriptor); // NOI18N
}
/**
- * Tests whether the specified object is a key in StringMapsString
or not
+ * Tests whether the specified object is a key in StringMapsString
or not.
*
* @param key possible key
*
diff --git a/src/main/java/Sirius/util/collections/SyncLinkedList.java b/src/main/java/Sirius/util/collections/SyncLinkedList.java
index b20e6d1..58f54b2 100644
--- a/src/main/java/Sirius/util/collections/SyncLinkedList.java
+++ b/src/main/java/Sirius/util/collections/SyncLinkedList.java
@@ -14,7 +14,7 @@
import java.util.*;
/**
- * Modified {@link LinkedList} for synchronisation
+ * Modified {@link LinkedList} for synchronisation.
*
* @author schlob
* @version $Revision$, $Date$
From b2e13ddc40c66c8b4342d8f37eaebbfd8eb73542 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Tue, 8 Jan 2013 14:09:50 +0100
Subject: [PATCH 13/34] #9 Java Doc Improvements of PostGisGeometryFactory.java
---
.../PostGisGeometryFactory.java | 38 +++++++++----------
1 file changed, 19 insertions(+), 19 deletions(-)
diff --git a/src/main/java/de/cismet/cismap/commons/jtsgeometryfactories/PostGisGeometryFactory.java b/src/main/java/de/cismet/cismap/commons/jtsgeometryfactories/PostGisGeometryFactory.java
index 3bb29de..2a8c447 100644
--- a/src/main/java/de/cismet/cismap/commons/jtsgeometryfactories/PostGisGeometryFactory.java
+++ b/src/main/java/de/cismet/cismap/commons/jtsgeometryfactories/PostGisGeometryFactory.java
@@ -19,7 +19,7 @@
import java.util.Collection;
/**
- * DOCUMENT ME!
+ * PostGisGeometryFactory.
*
* @author hell
* @version $Revision$, $Date$
@@ -37,7 +37,7 @@ public PostGisGeometryFactory() {
//~ Methods ----------------------------------------------------------------
/**
- * Getter for PostCompliantDBString
+ * Getter for PostCompliantDBString.
*
* @param g Geometry
*
@@ -52,7 +52,7 @@ public static String getPostGisCompliantDbString(final Geometry g) {
}
/**
- * Creates new JtsPoint
by using point
+ * Creates new JtsPoint
by using point.
*
* @param point point
* @param geometryFactory geometryFactory
@@ -64,7 +64,7 @@ private static Point createJtsPoint(final org.postgis.Point point, final Geometr
}
/**
- * Creates new JtsLineString
by using lineString
+ * Creates new JtsLineString
by using lineString.
*
* @param lineString lineString
* @param geometryFactory geometryFactory
@@ -81,7 +81,7 @@ private static LineString createJtsLineString(final org.postgis.LineString lineS
}
/**
- * Creates new JtsLinearRing
by using linearRing
+ * Creates new JtsLinearRing
by using linearRing.
*
* @param linearRing linearRing
* @param geometryFactory geometryFactory
@@ -103,14 +103,14 @@ private static LinearRing createJtsLinearRing(final org.postgis.LinearRing linea
}
/**
- * Creates new JtsPolygon
by using polygon
+ * Creates new JtsPolygon
by using polygon.
*
* @param polygon polygon
* @param geometryFactory geometryFactory
*
* @return polygon
- *
- * @see #createJtsLinearRing(org.postgis.LinearRing, com.vividsolutions.jts.geom.GeometryFactory)
+ *
+ * @see #createJtsLinearRing(org.postgis.LinearRing, com.vividsolutions.jts.geom.GeometryFactory)
*/
private static Polygon createJtsPolygon(final org.postgis.Polygon polygon, final GeometryFactory geometryFactory) {
final int ringcount = polygon.numRings();
@@ -130,14 +130,14 @@ private static Polygon createJtsPolygon(final org.postgis.Polygon polygon, final
}
/**
- * Creates new JtsMultiPoint
by using MultiPoint
+ * Creates new JtsMultiPoint
by using MultiPoint.
*
* @param multiPoint MultiPoint
* @param geometryFactory geometryFactory
*
* @return MultiPoint
- *
- * @see #createJtsPoint(org.postgis.Point, com.vividsolutions.jts.geom.GeometryFactory)
+ *
+ * @see #createJtsPoint(org.postgis.Point, com.vividsolutions.jts.geom.GeometryFactory)
*/
private static MultiPoint createJtsMultiPoint(final org.postgis.MultiPoint multiPoint,
final GeometryFactory geometryFactory) {
@@ -155,14 +155,14 @@ private static MultiPoint createJtsMultiPoint(final org.postgis.MultiPoint multi
}
/**
- * Creates new JtsMultiLineString
by using MultiLineString
+ * Creates new JtsMultiLineString
by using MultiLineString.
*
* @param multiLineString MultiLineString
* @param geometryFactory geometryFactory
*
* @return MultiLineString
- *
- * @see #createJtsLineString(org.postgis.LineString, com.vividsolutions.jts.geom.GeometryFactory)
+ *
+ * @see #createJtsLineString(org.postgis.LineString, com.vividsolutions.jts.geom.GeometryFactory)
*/
private static MultiLineString createJtsMultiLineString(final org.postgis.MultiLineString multiLineString,
final GeometryFactory geometryFactory) {
@@ -180,14 +180,14 @@ private static MultiLineString createJtsMultiLineString(final org.postgis.MultiL
}
/**
- * Creates new JtsMultiPolygon
by using MultiPolygon
+ * Creates new JtsMultiPolygon
by using MultiPolygon.
*
* @param multiPolygon MultiPolygon
!
* @param geometryFactory geometryFactory
*
* @return MultiPolygon
- *
- * @see #createJtsPolygon(org.postgis.Polygon, com.vividsolutions.jts.geom.GeometryFactory)
+ *
+ * @see #createJtsPolygon(org.postgis.Polygon, com.vividsolutions.jts.geom.GeometryFactory)
*/
private static MultiPolygon createJtsMultiPolygon(final org.postgis.MultiPolygon multiPolygon,
final GeometryFactory geometryFactory) {
@@ -205,7 +205,7 @@ private static MultiPolygon createJtsMultiPolygon(final org.postgis.MultiPolygon
}
/**
- * Creates new JtsGeometryCollection
by using GeometryCollection
+ * Creates new JtsGeometryCollection
by using GeometryCollection.
*
* @param geometryCollection GeometryCollection
* @param geometryFactory geometryFactory
@@ -264,7 +264,7 @@ private static GeometryCollection createJtsGeometryCollection(
}
/**
- * Creates new JtsGeometry
by using Geometry
+ * Creates new JtsGeometry
by using Geometry.
*
* @param geom Geometry
*
From 11ee1c34784de50d829b41af644d31f766c6c305 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Tue, 8 Jan 2013 14:10:46 +0100
Subject: [PATCH 14/34] #9 Java Doc Improvements of Proxy.java
---
src/main/java/de/cismet/netutil/Proxy.java | 53 +++++++++++-----------
1 file changed, 27 insertions(+), 26 deletions(-)
diff --git a/src/main/java/de/cismet/netutil/Proxy.java b/src/main/java/de/cismet/netutil/Proxy.java
index 7447c18..30d96e7 100644
--- a/src/main/java/de/cismet/netutil/Proxy.java
+++ b/src/main/java/de/cismet/netutil/Proxy.java
@@ -110,7 +110,7 @@ public Proxy(final String host,
//~ Methods ----------------------------------------------------------------
/**
- * Getter for host
+ * Getter for host.
*
* @return host
*/
@@ -119,7 +119,7 @@ public String getHost() {
}
/**
- * Setter for host
+ * Setter for host.
*
* @param host host
*/
@@ -128,7 +128,7 @@ public void setHost(final String host) {
}
/**
- * Getter for port
+ * Getter for port.
*
* @return port
*/
@@ -137,7 +137,7 @@ public int getPort() {
}
/**
- * Setter for port
+ * Setter for port.
*
* @param port port
*/
@@ -146,10 +146,11 @@ public void setPort(final int port) {
}
/**
- * return as String
- *
- * @return "Proxy: " + host
+ ":" + port
+ " | username: " + username
+
- " | password: " + ((password
== null
) ? null
: "") + " | domain: " + domain
+ * return as String.
+ *
+ * @return "Proxy: " + host
+ ":" + port
+ " | username: " + username
+" |
+ * password: " + ((password
== null
) ? null
: "") + " |
+ * domain: " + domain
*/
@Override
public String toString() {
@@ -158,7 +159,7 @@ public String toString() {
}
/**
- * Getter for domain
+ * Getter for domain.
*
* @return domain
*/
@@ -167,7 +168,7 @@ public String getDomain() {
}
/**
- * Setter for domain
+ * Setter for domain.
*
* @param domain domain
*/
@@ -176,7 +177,7 @@ public void setDomain(final String domain) {
}
/**
- * Getter for password
+ * Getter for password.
*
* @return password
*/
@@ -185,7 +186,7 @@ public String getPassword() {
}
/**
- * Setter for password
+ * Setter for password.
*
* @param password password
*/
@@ -194,7 +195,7 @@ public void setPassword(final String password) {
}
/**
- * Getter for username
+ * Getter for username.
*
* @return username
*/
@@ -203,7 +204,7 @@ public String getUsername() {
}
/**
- * Setter for username
+ * Setter for username.
*
* @param username username
*/
@@ -212,7 +213,7 @@ public void setUsername(final String username) {
}
/**
- * Tests whether enabled
is true or false
+ * Tests whether enabled
is true or false.
*
* @return true, if it is enabled
*/
@@ -221,7 +222,7 @@ public boolean isEnabled() {
}
/**
- * Enables or disables
+ * Enables or disables.
*
* @param enabled true
or false
*/
@@ -230,16 +231,16 @@ public void setEnabled(final boolean enabled) {
}
/**
- * Stores this proxy in the user's preferences.
- *
- * @see #toPreferences(de.cismet.netutil.Proxy)
+ * Stores this proxy in the user's preferences.
+ *
+ * @see #toPreferences(de.cismet.netutil.Proxy)
*/
public void toPreferences() {
toPreferences(this);
}
/**
- * Clears the Proxy Object
+ * Clears the Proxy Object.
*/
public static void clear() {
final Preferences prefs = Preferences.userNodeForPackage(Proxy.class);
@@ -315,8 +316,8 @@ public static void toPreferences(final Proxy proxy) {
}
/**
- * Loads a Proxy
instance from System preferences. If there are no host and port proxy
- * information null
will be returned. If the return value is non-null at least the host and the port is
+ * Loads a Proxy
instance from System preferences. If there are no host and port proxy information
+ * null
will be returned. If the return value is non-null at least the host and the port is
* initialised. Username, Password and Domain may be null.
*
* @return the user's proxy settings or null if no settings present
@@ -343,7 +344,7 @@ public static Proxy fromSystem() {
}
/**
- * main
+ * main.
*
* @param args args
*/
@@ -384,8 +385,8 @@ public static void main(final String[] args) {
}
/**
- * shows Message.
- * If there is no System.console it writes the meassage on OptionPane.Else it writes the message on Console as Error or Output.
+ * shows Message. If there is no System.console it writes the meassage on OptionPane.Else it writes the message on
+ * Console as Error or Output.
*
* @param message the message
* @param error true if it is a error message,false if not
@@ -407,7 +408,7 @@ private static void showMessage(final String message, final boolean error) {
}
/**
- * print usage
+ * print usage.
*/
private static void printUsage() {
showMessage("Supported parameters are:\n\n" // NOI18N
From a6378228535358d3ff4599b86eae12e290b4a10e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Tue, 8 Jan 2013 14:11:57 +0100
Subject: [PATCH 15/34] #9 Java Doc Improvements of TunnelTargetgroup.java
---
.../de/cismet/netutil/tunnel/TunnelTargetGroup.java | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/src/main/java/de/cismet/netutil/tunnel/TunnelTargetGroup.java b/src/main/java/de/cismet/netutil/tunnel/TunnelTargetGroup.java
index 88fb2fc..f92151b 100644
--- a/src/main/java/de/cismet/netutil/tunnel/TunnelTargetGroup.java
+++ b/src/main/java/de/cismet/netutil/tunnel/TunnelTargetGroup.java
@@ -48,7 +48,7 @@ public TunnelTargetGroup(final String targetGroupkey, final String[] targetExpre
//~ Methods ----------------------------------------------------------------
/**
- * Getter for targetExpressions
+ * Getter for targetExpressions.
*
* @return targetExpressions
*/
@@ -57,7 +57,7 @@ public String[] getTargetExpressions() {
}
/**
- * Setter for targetExpressions
+ * Setter for targetExpressions.
*
* @param targetExpressions targetExpressions
*/
@@ -66,7 +66,7 @@ public void setTargetExpressions(final String[] targetExpressions) {
}
/**
- * Getter for targetGroupkey
+ * Getter for targetGroupkey.
*
* @return targetGroupkey
*/
@@ -75,7 +75,7 @@ public String getTargetGroupkey() {
}
/**
- * Setter for targetGroupkey
+ * Setter for targetGroupkey.
*
* @param targetGroupkey targetGroupkey
*/
@@ -84,7 +84,7 @@ public void setTargetGroupkey(final String targetGroupkey) {
}
/**
- * Tests whether the String
matches or not
+ * Tests whether the String
matches or not.
*
* @param candidate given String
*
From f47997a2016595c9388dd3c91816532a2ae8b906 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Tue, 8 Jan 2013 14:12:47 +0100
Subject: [PATCH 16/34] #9 Java Doc Improvements of Package de.cismet.remote
---
.../AbstractRESTRemoteControlMethod.java | 20 +++++++++----------
.../RESTRemoteControlMethodRegistry.java | 14 ++++++-------
.../RESTRemoteControlMethodsApplication.java | 6 +++---
3 files changed, 20 insertions(+), 20 deletions(-)
diff --git a/src/main/java/de/cismet/remote/AbstractRESTRemoteControlMethod.java b/src/main/java/de/cismet/remote/AbstractRESTRemoteControlMethod.java
index 83ab8ca..c7bfa7e 100644
--- a/src/main/java/de/cismet/remote/AbstractRESTRemoteControlMethod.java
+++ b/src/main/java/de/cismet/remote/AbstractRESTRemoteControlMethod.java
@@ -28,7 +28,7 @@ public abstract class AbstractRESTRemoteControlMethod implements RESTRemoteContr
* @param port port
* @param path path
*
- * @throws NullPointerException "path must not be null"
+ * @throws NullPointerException "path must not be null"
* @throws IllegalArgumentException "path must not be empty" or "path has to start with '/'"
*/
public AbstractRESTRemoteControlMethod(final int port, final String path) {
@@ -51,9 +51,9 @@ public AbstractRESTRemoteControlMethod(final int port, final String path) {
//~ Methods ----------------------------------------------------------------
/**
- * Getter for Port
- *
- * @return port
+ * Getter for Port.
+ *
+ * @return port
*/
@Override
public int getPort() {
@@ -61,9 +61,9 @@ public int getPort() {
}
/**
- * Getter for Path
- *
- * @return path
+ * Getter for Path.
+ *
+ * @return path
*/
@Override
public String getPath() {
@@ -71,9 +71,9 @@ public String getPath() {
}
/**
- * return as String
- *
- * @return Class
+ name
+ " path: " + path
+ " port: " + port
+ * return as String.
+ *
+ * @return Class
+ name
+ " path: " + path
+ " port: " + port
*/
@Override
public String toString() {
diff --git a/src/main/java/de/cismet/remote/RESTRemoteControlMethodRegistry.java b/src/main/java/de/cismet/remote/RESTRemoteControlMethodRegistry.java
index 48ebf3a..659f0e6 100644
--- a/src/main/java/de/cismet/remote/RESTRemoteControlMethodRegistry.java
+++ b/src/main/java/de/cismet/remote/RESTRemoteControlMethodRegistry.java
@@ -37,12 +37,12 @@ private RESTRemoteControlMethodRegistry() {
//~ Methods ----------------------------------------------------------------
/**
- * caches RemoteMethods to portMapping
+ * caches RemoteMethods to portMapping.
*
* @param defaultPort default port
*
- * @throws IllegalStateException "RESTRemoteControlMethods have already been collected. "
- + "Call RESTRemoteControlMethodRegistry.clear() to enable new gathering"
+ * @throws IllegalStateException "RESTRemoteControlMethods have already been collected. " + "Call
+ * RESTRemoteControlMethodRegistry.clear() to enable new gathering"
*/
public static synchronized void gatherRemoteMethods(final int defaultPort) {
if (!portMapping.isEmpty()) {
@@ -76,7 +76,7 @@ public static synchronized void gatherRemoteMethods(final int defaultPort) {
}
/**
- * Gets the Methods of specified Port
+ * Gets the Methods of specified Port.
*
* @param port port
*
@@ -88,7 +88,7 @@ public static synchronized List getMethodsForPort(final
}
/**
- * Gettter for Methodports
+ * Gettter for Methodports.
*
* @return Methodports
*/
@@ -97,14 +97,14 @@ public static synchronized Set getMethodPorts() {
}
/**
- * Clears the Portmapping
+ * Clears the Portmapping.
*/
public static synchronized void clear() {
portMapping.clear();
}
/**
- * Tests whether the map is empty or not
+ * Tests whether the map is empty or not.
*
* @return True
if this map contains no key-value mappings
*/
diff --git a/src/main/java/de/cismet/remote/RESTRemoteControlMethodsApplication.java b/src/main/java/de/cismet/remote/RESTRemoteControlMethodsApplication.java
index a9285c4..3595bc5 100644
--- a/src/main/java/de/cismet/remote/RESTRemoteControlMethodsApplication.java
+++ b/src/main/java/de/cismet/remote/RESTRemoteControlMethodsApplication.java
@@ -65,9 +65,9 @@ private void collectServiceClasses(final String portAsString) {
}
/**
- * Getter for Classes
- *
- * @return class
+ * Getter for Classes.
+ *
+ * @return class
*/
@Override
public synchronized Set> getClasses() {
From fec932151fa961968c20a48749e60ed728452ee7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Tue, 8 Jan 2013 14:14:06 +0100
Subject: [PATCH 17/34] #9 Java Doc Improvements of ConfigurationManager.java
---
.../de/cismet/tools/configuration/ConfigurationManager.java | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java b/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java
index 4a4ad02..5c1936f 100644
--- a/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java
+++ b/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java
@@ -524,8 +524,8 @@ public String getSubstitutionAttr(final Element e) {
}
/**
- * Creates a {@link Set} from the given xml snippet. This implementation assumes that there is a single
- * root {@link Element} whose only purpose is to wrap the {@link Element}s to be created. In other words this
+ * Creates a {@link Set} from the given xml snippet. This implementation assumes that there is a single root
+ * {@link Element} whose only purpose is to wrap the {@link Element}s to be created. In other words this
* implementation will return the child {@link Element}s of the {@link Document}'s root {@link Element}. The
* returned {@link Element}s are detached from their root so they can be inserted into another {@link Document}.
*
From 5f8bff61c7eeac6473ed4f533a98553409f74506 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Tue, 8 Jan 2013 14:14:57 +0100
Subject: [PATCH 18/34] #9 Java Doc Improvements of Package de.cismet.tools
---
src/main/java/de/cismet/tools/Base64.java | 2 +-
.../cismet/tools/BlacklistClassloading.java | 8 +-
.../java/de/cismet/tools/BrowserLauncher.java | 20 +-
.../de/cismet/tools/CalculationCache.java | 5 +-
src/main/java/de/cismet/tools/Calculator.java | 2 +-
.../de/cismet/tools/CismetThreadPool.java | 9 +-
.../java/de/cismet/tools/ConnectionInfo.java | 12 +-
src/main/java/de/cismet/tools/Converter.java | 4 +-
.../de/cismet/tools/CurrentStackTrace.java | 2 +-
.../java/de/cismet/tools/DebugSwitches.java | 4 +-
src/main/java/de/cismet/tools/FileUtils.java | 166 +++++++++--------
src/main/java/de/cismet/tools/JnlpTools.java | 2 +-
.../de/cismet/tools/LinkedProperties.java | 173 ++++++++++--------
.../cismet/tools/NumberStringComparator.java | 2 +-
.../de/cismet/tools/PasswordEncrypter.java | 135 +++++++-------
.../tools/PasswordEncrypterException.java | 2 +-
.../cismet/tools/PropertyEqualsProvider.java | 2 +-
.../java/de/cismet/tools/PropertyReader.java | 2 +-
.../java/de/cismet/tools/ScriptRunner.java | 10 +-
src/main/java/de/cismet/tools/Sorter.java | 61 +++---
.../de/cismet/tools/StaticDebuggingTools.java | 2 +-
.../de/cismet/tools/StaticDecimalTools.java | 4 +-
.../java/de/cismet/tools/StaticHtmlTools.java | 4 +-
.../java/de/cismet/tools/StaticXMLTools.java | 8 +-
.../java/de/cismet/tools/StringTools.java | 4 +-
.../java/de/cismet/tools/TextFromFile.java | 4 +-
.../java/de/cismet/tools/TimeoutThread.java | 4 +-
.../java/de/cismet/tools/URLSplitter.java | 22 +--
28 files changed, 347 insertions(+), 328 deletions(-)
diff --git a/src/main/java/de/cismet/tools/Base64.java b/src/main/java/de/cismet/tools/Base64.java
index 6ec825e..4fb972c 100644
--- a/src/main/java/de/cismet/tools/Base64.java
+++ b/src/main/java/de/cismet/tools/Base64.java
@@ -8,7 +8,7 @@
package de.cismet.tools;
/**
- * Base64 Converter
+ * Base64 Converter.
*
* @author martin.scholl@cismet.de
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/BlacklistClassloading.java b/src/main/java/de/cismet/tools/BlacklistClassloading.java
index 90ae250..66c1567 100644
--- a/src/main/java/de/cismet/tools/BlacklistClassloading.java
+++ b/src/main/java/de/cismet/tools/BlacklistClassloading.java
@@ -13,7 +13,7 @@
import java.util.Map;
/**
- * Blacklist
+ * Blacklist.
*
* @author srichter
* @version $Revision$, $Date$
@@ -39,9 +39,9 @@ private BlacklistClassloading() {
//~ Methods ----------------------------------------------------------------
/**
- * Tests whether the class is available or not.
- * It sends messages to the Logger, if he can't find the class identity(additional he adds the identity on the blacklist),
- * if he already has the class on the blacklist or if the classname was null
+ * Tests whether the class is available or not. It sends messages to the Logger, if he can't find the class
+ * identity(additional he adds the identity on the blacklist), if he already has the class on the blacklist or if
+ * the classname was null
*
* @param classname classname to load
*
diff --git a/src/main/java/de/cismet/tools/BrowserLauncher.java b/src/main/java/de/cismet/tools/BrowserLauncher.java
index bc4bb8d..bd9f7a1 100644
--- a/src/main/java/de/cismet/tools/BrowserLauncher.java
+++ b/src/main/java/de/cismet/tools/BrowserLauncher.java
@@ -460,8 +460,8 @@ private static Object locateBrowser() {
}
/**
- * Attempts to open the default web browser to the gieven URL.
- * In the second attempt he tries to open the url as a file.
+ * Attempts to open the default web browser to the gieven URL. In the second attempt he tries to open the url as a
+ * file.
*
* @param url DOCUMENT ME!
*/
@@ -489,14 +489,14 @@ public static void openURLorFile(final String url) {
*
* @param url The URL to open
*
- * @throws Exception
- * @throws IOException
- *
- * - If the web browser could not be located or does not run
- * - If it catches a
InvocationTargetException
- * - If it catches a
IllegalAccessExeption
- * - if it catches a
InstantiationException
- *
+ * @throws Exception DOCUMENT ME!
+ * @throws IOException
+ *
+ * - If the web browser could not be located or does not run
+ * - If it catches a
InvocationTargetException
+ * - If it catches a
IllegalAccessExeption
+ * - if it catches a
InstantiationException
+ *
*/
public static void openURL(final String url) throws Exception {
if (log.isDebugEnabled()) {
diff --git a/src/main/java/de/cismet/tools/CalculationCache.java b/src/main/java/de/cismet/tools/CalculationCache.java
index 1d16ee6..f6eb565 100644
--- a/src/main/java/de/cismet/tools/CalculationCache.java
+++ b/src/main/java/de/cismet/tools/CalculationCache.java
@@ -118,7 +118,7 @@ public void run() {
}
/**
- * Get the time in milliseconds, the result should be cached
+ * Get the time in milliseconds, the result should be cached.
*
* @return the time in milliseconds
*/
@@ -136,8 +136,7 @@ public void setTimeToCacheResults(final long timeToCacheResults) {
}
/**
- * get the time in milliseconds, exceptions, which were thrown during the calculation of a value, should be
- * cached
+ * get the time in milliseconds, exceptions, which were thrown during the calculation of a value, should be cached.
*
* @return the time in milliseconds
*/
diff --git a/src/main/java/de/cismet/tools/Calculator.java b/src/main/java/de/cismet/tools/Calculator.java
index 911d833..419f813 100644
--- a/src/main/java/de/cismet/tools/Calculator.java
+++ b/src/main/java/de/cismet/tools/Calculator.java
@@ -8,7 +8,7 @@
package de.cismet.tools;
/**
- * Calculator
+ * Calculator.
*
* @author therter
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/CismetThreadPool.java b/src/main/java/de/cismet/tools/CismetThreadPool.java
index 882f391..af817d2 100644
--- a/src/main/java/de/cismet/tools/CismetThreadPool.java
+++ b/src/main/java/de/cismet/tools/CismetThreadPool.java
@@ -64,9 +64,8 @@ public static Future> submit(final Runnable command) {
}
/**
- * Attempts to stop all actively executing tasks, halts the
- * processing of waiting tasks, and returns a list of the tasks
- * that were awaiting execution.
+ * Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the
+ * tasks that were awaiting execution.
*
* @return list
*/
@@ -77,8 +76,8 @@ public static List shutdownNow() {
}
/**
- * Initiates an orderly shutdown in which previously submitted
- * tasks are executed, but no new tasks will be accepted.
+ * Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be
+ * accepted.
*/
public static void shutdown() {
SINGLE_WORKER_POOL.shutdown();
diff --git a/src/main/java/de/cismet/tools/ConnectionInfo.java b/src/main/java/de/cismet/tools/ConnectionInfo.java
index 39b5b38..1afa3f1 100644
--- a/src/main/java/de/cismet/tools/ConnectionInfo.java
+++ b/src/main/java/de/cismet/tools/ConnectionInfo.java
@@ -52,7 +52,7 @@ public ConnectionInfo(final Element element) { // throws NullPointe
//~ Methods ----------------------------------------------------------------
/**
- * Returns the DriverClass
+ * Returns the DriverClass.
*
* @return DriverClass
*/
@@ -61,7 +61,7 @@ public String getDriver() {
}
/**
- * Sets the DriverClass
+ * Sets the DriverClass.
*
* @param driver Driver Class
*/
@@ -70,7 +70,7 @@ public void setDriver(final String driver) {
}
/**
- * Returns the DB Url
+ * Returns the DB Url.
*
* @return DB Url
*/
@@ -79,7 +79,7 @@ public String getUrl() {
}
/**
- * Sets the DB Url
+ * Sets the DB Url.
*
* @param url DB Url
*/
@@ -119,7 +119,7 @@ public String getPass() {
}
/**
- * Sets Password
+ * Sets Password.
*
* @param pass Password
*/
@@ -128,7 +128,7 @@ public void setPass(final String pass) {
}
/**
- * Getter for Element
+ * Getter for Element.
*
* @return Element
*/
diff --git a/src/main/java/de/cismet/tools/Converter.java b/src/main/java/de/cismet/tools/Converter.java
index 0c16ae1..35ef734 100644
--- a/src/main/java/de/cismet/tools/Converter.java
+++ b/src/main/java/de/cismet/tools/Converter.java
@@ -125,7 +125,7 @@ public static T deserialiseFromBase64(final byte[] bytes, final Class typ
*
* @return the base64 encoded bytes
*
- * @see Base64#encodeBase64(byte[])
+ * @see org.apache.commons.codec.binary.Base64#encodeBase64(byte[])
*/
public static byte[] toBase64(final byte[] bytes) {
return Base64.encodeBase64(bytes);
@@ -138,7 +138,7 @@ public static byte[] toBase64(final byte[] bytes) {
*
* @return the system encoded bytes or null
if the given byte[]
is null
*
- * @see Base64#decodeBase64(byte[])
+ * @see org.apache.commons.codec.binary.Base64#decodeBase64(byte[])
*/
public static byte[] fromBase64(final byte[] bytes) {
if (bytes == null) {
diff --git a/src/main/java/de/cismet/tools/CurrentStackTrace.java b/src/main/java/de/cismet/tools/CurrentStackTrace.java
index 6f50ef3..ac4a49c 100644
--- a/src/main/java/de/cismet/tools/CurrentStackTrace.java
+++ b/src/main/java/de/cismet/tools/CurrentStackTrace.java
@@ -12,7 +12,7 @@
package de.cismet.tools;
/**
- * CurrentStackTrace
+ * CurrentStackTrace.
*
* @author thorsten
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/DebugSwitches.java b/src/main/java/de/cismet/tools/DebugSwitches.java
index c9914ba..7f81cb5 100644
--- a/src/main/java/de/cismet/tools/DebugSwitches.java
+++ b/src/main/java/de/cismet/tools/DebugSwitches.java
@@ -12,7 +12,7 @@
package de.cismet.tools;
/**
- * debug Switches
+ * debug Switches.
*
* @author thorsten
* @version $Revision$, $Date$
@@ -38,7 +38,7 @@ private DebugSwitches() {
//~ Methods ----------------------------------------------------------------
/**
- * Getter for Instance
+ * Getter for Instance.
*
* @return instance
*/
diff --git a/src/main/java/de/cismet/tools/FileUtils.java b/src/main/java/de/cismet/tools/FileUtils.java
index 347062c..ddad282 100644
--- a/src/main/java/de/cismet/tools/FileUtils.java
+++ b/src/main/java/de/cismet/tools/FileUtils.java
@@ -21,7 +21,7 @@
import java.util.jar.JarFile;
/**
- * FileUtils Class
+ * FileUtils Class.
*
* @author mscholl
* @version 1.3
@@ -53,20 +53,20 @@ private FileUtils() {
//~ Methods ----------------------------------------------------------------
/**
- * Tests whether the specified File
is a MetaFiles
or not
+ * Tests whether the specified File
is a MetaFiles
or not.
*
* @param check File
to be tested
*
* @return true if the tested File
is a MetaFile
- *
- * @see #isMetaFile(java.io.File, int)
+ *
+ * @see #isMetaFile(java.io.File, int)
*/
public static boolean isMetaFile(final File check) {
return isMetaFile(check, getMode());
}
/**
- * Tests whether the specified File
is a MetaFile
of the tested OS
or not
+ * Tests whether the specified File
is a MetaFile
of the tested OS
or not.
*
* @param check File
to be tested
* @param mode Number of OS
to be tested
@@ -78,7 +78,7 @@ public static boolean isMetaFile(final File check, final int mode) {
}
/**
- * Getter for MetaEntries
of the specified Meta
+ * Getter for MetaEntries
of the specified Meta.
*
* @param mode Metanumber
*
@@ -118,7 +118,7 @@ private static String[] getMetaEntries(final int mode) {
}
/**
- * Tests whether the specified File
has the specified Metaentries
or not
+ * Tests whether the specified File
has the specified Metaentries
or not.
*
* @param filename name of the tested File
* @param meta Metaentries
to be tested
@@ -153,9 +153,9 @@ private static int getMode() {
}
/**
- * Getter for the name of the specified File
+ * Getter for the name of the specified File.
*
- * @param file given File
+ * @param file given File
*
* @return FileName
*/
@@ -170,7 +170,7 @@ public static String getName(final File file) {
}
/**
- * Getter for the Filestype of the specified File
+ * Getter for the Filestype of the specified File.
*
* @param file given file
*
@@ -187,29 +187,31 @@ public static String getExt(final File file) {
}
/**
- * Tests whether the specified File
only contains MetaFiles
of one type or not
+ * Tests whether the specified File
only contains MetaFiles
of one type or not.
*
* @param check File
to be tested
*
* @return true, if it only contains MetaFiles
- *
- * @see {@link #containsOnlyMetaFiles(java.io.File, int)}
+ *
+ * @see #containsOnlyMetaFiles(java.io.File, int)
*/
public static boolean containsOnlyMetaFiles(final File check) {
return containsOnlyMetaFiles(check, getMode());
}
/**
- * Tests whether the specified Directory
only contains MetaFiles
of the specified OS
- *
- * @param check Directory/code> to be tested
+ * Tests whether the specified Directory
only contains MetaFiles
of the specified
+ * OS.
+ *
+ * @param check Directory
, which is going to get tested.
* @param mode Os
*
* @return true, if it only contains MetaFiles
of the tested Os
*
- * @throws IllegalArgumentException throws IllegalArgumentException
if the File
isn't a Directory
- *
- * @see #isMetaFile(java.io.File, int)
+ * @throws IllegalArgumentException throws IllegalArgumentException
if the File
isn't a
+ * Directory
+ *
+ * @see #isMetaFile(java.io.File, int)
*/
public static boolean containsOnlyMetaFiles(final File check, final int mode) {
if (!check.isDirectory()) {
@@ -225,16 +227,14 @@ public static boolean containsOnlyMetaFiles(final File check, final int mode) {
return true;
}
/**
- * Copies the specified File
- * Note: exception thrown and not handled to avoid logger call if it is necessary to use logger in this class return
- * boolean and handle exceptions.
+ * Copies the specified File
Note: exception thrown and not handled to avoid logger call if it is
+ * necessary to use logger in this class return boolean and handle exceptions.
*
* @param inFile input File
* @param outFile target File
*
* @throws FileNotFoundException FileNotFoundException
* @throws IOException IOException
- *
*/
public static void copyFile(final File inFile, final File outFile) throws FileNotFoundException, IOException {
FileInputStream fis = null;
@@ -258,7 +258,9 @@ public static void copyFile(final File inFile, final File outFile) throws FileNo
}
/**
- * Copies the Content of the specified Directory
. It uses {@link FilesFilter}. If it is a File
, it copies the File and if it is a Directory
, the methode start recursive again with the found Directory
Directory
. It uses {@link FilesFilter}. If it is a
+ * File
, it copies the File and if it is a Directory
, the methode start recursive again with the
+ * found Directory
*
* @param srcDir Source Directory
* @param destDir Target Directory
@@ -266,14 +268,12 @@ public static void copyFile(final File inFile, final File outFile) throws FileNo
* @param recursive recursive
*
* @throws FileNotFoundException throws FileNotFoundException if:
- *
- *
- * - the Source
File
is not a Directory
- * - the Target
File
is not a Directory
- *
- *
- * @throws IOException IOException
- *
+ *
+ *
+ * - the Source
File
is not a Directory
+ * - the Target
File
is not a Directory
+ *
+ * @throws IOException IOException
*/
public static void copyContent(
final File srcDir,
@@ -312,11 +312,12 @@ public static void copyContent(
* @param recursive recursive
*
* @throws IOException IOException
- *
- * - source dir is not a directory
- * - a File couldn't be deleted
- * - a Folder couldn't be deleted
- *
+ *
+ *
+ * - source dir is not a directory
+ * - a File couldn't be deleted
+ * - a Folder couldn't be deleted
+ *
*/
public static void deleteContent(final File srcDir, final boolean recursive) throws IOException {
if (!srcDir.isDirectory()) {
@@ -345,15 +346,16 @@ public static void deleteContent(final File srcDir, final boolean recursive) thr
}
/**
- * Deletes the Given Folder
+ * Deletes the Given Folder.
*
* @param srcDir given Directory
*
* @throws IOException IOException
- *
- * - Source Directory is not a Directory
- * - Could not delete File
- *
+ *
+ *
+ * - Source Directory is not a Directory
+ * - Could not delete File
+ *
*/
public static void deleteDir(final File srcDir) throws IOException {
if (!srcDir.isDirectory()) {
@@ -370,21 +372,22 @@ public static void deleteDir(final File srcDir) throws IOException {
}
/**
- * Extracts given Jar File to given Folder
+ * Extracts given Jar File to given Folder.
*
* @param jar Jar File
* @param dest Directory
* @param filter filter
*
* @throws IOException IOException
- *
- * - dest dir does not exist
- * - jar file does not exist
- * - dest dir is not a directory
- * - cannot write to dest directory
- * - cannot read jar file
- * - culd not create dir
- *
+ *
+ *
+ * - dest dir does not exist
+ * - jar file does not exist
+ * - dest dir is not a directory
+ * - cannot write to dest directory
+ * - cannot read jar file
+ * - culd not create dir
+ *
*/
public static void extractJar(final File jar, final File dest, final FileFilter filter) throws IOException {
if (!dest.exists()) {
@@ -442,7 +445,7 @@ public static void extractJar(final File jar, final File dest, final FileFilter
//~ Inner Classes ----------------------------------------------------------
/**
- * Filter for searching for .jar Files
+ * Filter for searching for .jar Files.
*
* @version $Revision$, $Date$
*/
@@ -451,11 +454,11 @@ public static final class JarFilter implements FileFilter {
//~ Methods ------------------------------------------------------------
/**
- * Tests whether the given File
is .jar File
or not
- *
- * @param file given File
- *
- * @return true, if the File
is a .jar File
+ * Tests whether the given File
is .jar File
or not.
+ *
+ * @param file given File
+ *
+ * @return true, if the File
is a .jar File
*/
@Override
public boolean accept(final File file) {
@@ -464,7 +467,7 @@ public boolean accept(final File file) {
}
/**
- * Filter for searching for .jar Files and Directories
+ * Filter for searching for .jar Files and Directories.
*
* @version $Revision$, $Date$
*/
@@ -473,11 +476,11 @@ public static final class DirAndJarFilter implements FileFilter {
//~ Methods ------------------------------------------------------------
/**
- * Tests whether the File
is a Directory
or a .jar File
- *
- * @param file given File
- *
- * @return true, if the File
is a .jar File
or a Directory
+ * Tests whether the File
is a Directory
or a .jar File.
+ *
+ * @param file given File
+ *
+ * @return true, if the File
is a .jar File
or a Directory
*/
@Override
public boolean accept(final File file) {
@@ -486,7 +489,7 @@ public boolean accept(final File file) {
}
/**
- * Filter for searching for Directories
+ * Filter for searching for Directories.
*
* @version $Revision$, $Date$
*/
@@ -496,12 +499,12 @@ public static final class DirectoryFilter implements FileFilter {
/**
* Tests whether the File
is Directory
or not.
- *
- * @param file given File
- *
- * @return true, if the File
is a Directory
+ *
+ * @param file given File
+ *
+ * @return true, if the File
is a Directory
*/
-
+
@Override
public boolean accept(final File file) {
return file.isDirectory();
@@ -509,7 +512,7 @@ public boolean accept(final File file) {
}
/**
- * Filter for searching for Files
+ * Filter for searching for Files.
*
* @version $Revision$, $Date$
*/
@@ -519,12 +522,13 @@ public static final class FilesFilter implements FileFilter {
/**
* Tests whether the File
is Directory
or not.
- *
- * @param file given File
- *
- * @return true, if the File
is Not! a Directory
, false if it is a Directory
+ *
+ * @param file given File
+ *
+ * @return true, if the File
is Not! a Directory
, false if it is a
+ * Directory
*/
-
+
@Override
public boolean accept(final File file) {
return !file.isDirectory();
@@ -532,20 +536,20 @@ public boolean accept(final File file) {
}
/**
- * Filter for searching for MetaFiles
+ * Filter for searching for MetaFiles.
*
* @version $Revision$, $Date$
*/
public static final class MetaInfFilter implements FileFilter {
//~ Methods ------------------------------------------------------------
-
+
/**
* Tests whether the File
is Meta File
or not.
- *
- * @param file given File
- *
- * @return true, if the File
is a Meta File
+ *
+ * @param file given File
+ *
+ * @return true, if the File
is a Meta File
*/
@Override
public boolean accept(final File file) {
diff --git a/src/main/java/de/cismet/tools/JnlpTools.java b/src/main/java/de/cismet/tools/JnlpTools.java
index a280958..012a1d7 100644
--- a/src/main/java/de/cismet/tools/JnlpTools.java
+++ b/src/main/java/de/cismet/tools/JnlpTools.java
@@ -10,7 +10,7 @@
import java.util.Locale;
/**
- * JnlpTools Class
+ * JnlpTools Class.
*
* @author martin.scholl@cismet.de
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/LinkedProperties.java b/src/main/java/de/cismet/tools/LinkedProperties.java
index 8c580a7..2097244 100644
--- a/src/main/java/de/cismet/tools/LinkedProperties.java
+++ b/src/main/java/de/cismet/tools/LinkedProperties.java
@@ -20,7 +20,7 @@
import java.util.Set;
/**
- * Linked Properties
+ * Linked Properties.
*
* @author thorsten
* @version $Revision$, $Date$
@@ -32,30 +32,29 @@ public class LinkedProperties extends Properties {
private final LinkedHashMap map = new LinkedHashMap();
//~ Methods ----------------------------------------------------------------
-
+
/**
- * Associates a given value
with a given key
value
associated with key
, or
- * null
if there was no mapping for key
.
- * (A null
return can also indicate that the map
- * previously associated null
with key
.)
+ * Associates a given value
with a given key.
+ *
+ * @param key DOCUMENT ME!
+ * @param value DOCUMENT ME!
+ *
+ * @return the previous value
associated with key
, or null
if there was no
+ * mapping for key
. (A null
return can also indicate that the map previously
+ * associated null
with key
.)
*/
-
+
@Override
public synchronized Object put(final Object key, final Object value) {
return map.put(key, value);
}
/**
- * Returns the value
for the given key
- *
- * @param key
- *
- * @return the associated value
. Returns null
, if the is no mapping for this key.
+ * Returns the value
for the given key.
+ *
+ * @param key DOCUMENT ME!
+ *
+ * @return the associated value
. Returns null
, if the is no mapping for this key.
*/
@Override
public synchronized Object get(final Object key) {
@@ -63,16 +62,20 @@ public synchronized Object get(final Object key) {
}
/**
- * Removes every mapping
of this map
+ * Removes every mapping
of this map.
*/
-
+
@Override
public synchronized void clear() {
map.clear();
}
/**
- * @throws UnsupportedOperationException
+ * DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ *
+ * @throws UnsupportedOperationException DOCUMENT ME!
*/
@Override
public synchronized Object clone() {
@@ -80,38 +83,38 @@ public synchronized Object clone() {
}
/**
- * Tests whether there is any mapping
with this value
or not
- *
- * @param value value whose presence in this map is to be tested
- *
- * @return True, if there is a key
with this value
+ * Tests whether there is any mapping
with this value
or not.
+ *
+ * @param value value whose presence in this map is to be tested
+ *
+ * @return True, if there is a key
with this value
*/
@Override
public boolean containsValue(final Object value) {
return map.containsValue(value);
}
- /**
- * Tests whether there is any mapping
with this value
or not
- *
- * @param value value whose presence in this map is to be tested
- *
- * @return True, if there is a key
with this value
+ /**
+ * Tests whether there is any mapping
with this value
or not.
+ *
+ * @param value value whose presence in this map is to be tested
+ *
+ * @return True, if there is a key
with this value
*/
-
+
@Override
public synchronized boolean contains(final Object value) {
return containsValue(value);
}
- /**
- * Tests whether the specified key is in the map or not
- *
- * @param key key whose presence in this map is to be tested
- *
- * @return True, if there is a key
+ /**
+ * Tests whether the specified key is in the map or not.
+ *
+ * @param key key whose presence in this map is to be tested
+ *
+ * @return True, if there is a key
*/
-
+
@Override
public synchronized boolean containsKey(final Object key) {
return map.containsKey(key);
@@ -119,8 +122,8 @@ public synchronized boolean containsKey(final Object key) {
/**
* Returns all values
. Uses an Iterator
over all elements
.
- *
- * @return every value
in this map
+ *
+ * @return every value
in this map
*/
@Override
public synchronized Enumeration elements() {
@@ -129,8 +132,8 @@ public synchronized Enumeration elements() {
/**
* Returns a Set
view of the mappings contained in this map.
- *
- * @return Set
+ *
+ * @return Set
*/
@Override
public Set entrySet() {
@@ -138,18 +141,24 @@ public Set entrySet() {
}
/**
- * @throws UnsupportedOperationException
+ * DOCUMENT ME!
+ *
+ * @param o DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ *
+ * @throws UnsupportedOperationException DOCUMENT ME!
*/
-
+
@Override
public synchronized boolean equals(final Object o) {
throw new UnsupportedOperationException();
}
/**
- * Tests whether there is any mapping on the map or not
- *
- * @return true, if there is no mapping
+ * Tests whether there is any mapping on the map or not.
+ *
+ * @return true, if there is no mapping
*/
@Override
public synchronized boolean isEmpty() {
@@ -158,8 +167,8 @@ public synchronized boolean isEmpty() {
/**
* Returns all keys
. Uses an Iterator
over all elements
.
- *
- * @return every key
in this map
+ *
+ * @return every key
in this map
*/
@Override
public synchronized Enumeration keys() {
@@ -168,8 +177,8 @@ public synchronized Enumeration keys() {
/**
* Returns a Set
view of the keys contained in this map.
- *
- * @return Set
+ *
+ * @return Set
*/
@Override
public Set keySet() {
@@ -177,7 +186,11 @@ public Set keySet() {
}
/**
- * @throws UnsupportedOperationException
+ * DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ *
+ * @throws UnsupportedOperationException DOCUMENT ME!
*/
@Override
public Enumeration propertyNames() {
@@ -185,11 +198,11 @@ public Enumeration propertyNames() {
}
/**
- * Copies all of the mappings
from the specified map
to this map
.
- * These mappings
will replace any mappings
that this map
had for
- * any of the keys
currently in the specified map
- *
- * @param t map
+ * Copies all of the mappings
from the specified map
to this map
. These
+ * mappings
will replace any mappings
that this map
had for any of the
+ * keys
currently in the specified map
+ *
+ * @param t map
*/
@Override
public synchronized void putAll(final Map t) {
@@ -197,10 +210,12 @@ public synchronized void putAll(final Map t) {
}
/**
- * Removes specified key
- * @param key key
- * @return the previous value
associated with key
, or
- * null
if there was no mapping for key
.
+ * Removes specified key.
+ *
+ * @param key key
+ *
+ * @return the previous value
associated with key
, or null
if there was no
+ * mapping for key
.
*/
@Override
public synchronized Object remove(final Object key) {
@@ -210,7 +225,7 @@ public synchronized Object remove(final Object key) {
/**
* Returns the number of key-value mappings in this map.
*
- * @return the number of key-value mappings in this map
+ * @return the number of key-value mappings in this map
*/
@Override
public synchronized int size() {
@@ -218,7 +233,11 @@ public synchronized int size() {
}
/**
- * @throws UnsupportedOperationException
+ * DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ *
+ * @throws UnsupportedOperationException DOCUMENT ME!
*/
@Override
public Collection values() {
@@ -226,14 +245,13 @@ public Collection values() {
}
/**
- * Searches for the property with the specified key in this property list.
- * If the key is not found in this property list, the default property list,
- * and its defaults, recursively, are then checked. The method returns
- * null
if the property is not found.
- *
- * @param key the property key
- *
- * @return the value in this property list with the specified key value.
+ * Searches for the property with the specified key in this property list. If the key is not found in this property
+ * list, the default property list, and its defaults, recursively, are then checked. The method returns
+ * null
if the property is not found.
+ *
+ * @param key the property key
+ *
+ * @return the value in this property list with the specified key value.
*/
@Override
public String getProperty(final String key) {
@@ -244,7 +262,7 @@ public String getProperty(final String key) {
}
/**
- * IteratorEnumeration
+ * IteratorEnumeration.
*
* @version $Revision$, $Date$
*/
@@ -274,8 +292,8 @@ public IteratorEnumeration(final Iterator i) {
/**
* Tests whether the Iterator
as more Elemtents or not.
- *
- * @return True
, if the Iterator
has more Elements.
+ *
+ * @return True
, if the Iterator
has more Elements.
*/
@Override
public boolean hasMoreElements() {
@@ -284,9 +302,8 @@ public boolean hasMoreElements() {
/**
* Returns the next element in the iteration.
- *
- * @return the next element in the iteration
- * @throws NoSuchElementException if the iteration has no more elements
+ *
+ * @return the next element in the iteration
*/
@Override
public Object nextElement() {
diff --git a/src/main/java/de/cismet/tools/NumberStringComparator.java b/src/main/java/de/cismet/tools/NumberStringComparator.java
index 0b80d16..f4796d0 100644
--- a/src/main/java/de/cismet/tools/NumberStringComparator.java
+++ b/src/main/java/de/cismet/tools/NumberStringComparator.java
@@ -56,7 +56,7 @@ public NumberStringComparator() {
//~ Methods ----------------------------------------------------------------
/**
- * Compare Methode
+ * Compare Methode.
*
* @param o1 Object one
* @param o2 object two
diff --git a/src/main/java/de/cismet/tools/PasswordEncrypter.java b/src/main/java/de/cismet/tools/PasswordEncrypter.java
index d426f38..82395e8 100644
--- a/src/main/java/de/cismet/tools/PasswordEncrypter.java
+++ b/src/main/java/de/cismet/tools/PasswordEncrypter.java
@@ -38,7 +38,7 @@
import javax.swing.UIManager;
/**
- * Applet Password Encrypter
+ * Applet Password Encrypter.
*
* @author thorsten.hell@cismet.de
* @author martin.scholl@cismet.de
@@ -235,31 +235,31 @@ public void focusGained(final java.awt.event.FocusEvent evt) {
} // //GEN-END:initComponents
/**
- * Focus Gained Password2
+ * Focus Gained Password2.
*
* @param evt Event
*/
- private void pwfPassword2FocusGained(final java.awt.event.FocusEvent evt) {//GEN-FIRST:event_pwfPassword2FocusGained
+ private void pwfPassword2FocusGained(final java.awt.event.FocusEvent evt) { //GEN-FIRST:event_pwfPassword2FocusGained
pwfPassword2.setSelectionStart(0);
pwfPassword2.setSelectionEnd(pwfPassword1.getPassword().length);
- }//GEN-LAST:event_pwfPassword2FocusGained
+ } //GEN-LAST:event_pwfPassword2FocusGained
/**
- * Focus Gained Password1
+ * Focus Gained Password1.
*
* @param evt Event
*/
- private void pwfPassword1FocusGained(final java.awt.event.FocusEvent evt) {//GEN-FIRST:event_pwfPassword1FocusGained
+ private void pwfPassword1FocusGained(final java.awt.event.FocusEvent evt) { //GEN-FIRST:event_pwfPassword1FocusGained
pwfPassword1.setSelectionStart(0);
pwfPassword1.setSelectionEnd(pwfPassword1.getPassword().length);
- }//GEN-LAST:event_pwfPassword1FocusGained
+ } //GEN-LAST:event_pwfPassword1FocusGained
/**
- * Starter
+ * Starter.
*
* @param evt Event
*/
- private void cmdGoActionPerformed(final java.awt.event.ActionEvent evt) {//GEN-FIRST:event_cmdGoActionPerformed
+ private void cmdGoActionPerformed(final java.awt.event.ActionEvent evt) { //GEN-FIRST:event_cmdGoActionPerformed
final String p1 = new String(pwfPassword1.getPassword());
final String p2 = new String(pwfPassword2.getPassword());
if (p1.equals(p2)) {
@@ -296,14 +296,14 @@ private void cmdGoActionPerformed(final java.awt.event.ActionEvent evt) {//GEN-F
pwfPassword1.setText(""); // NOI18N
pwfPassword2.setText(""); // NOI18N
}
- }//GEN-LAST:event_cmdGoActionPerformed
+ } //GEN-LAST:event_cmdGoActionPerformed
/**
- * main
+ * main.
*
* @param args the command line arguments
*
- * @throws Exception
+ * @throws Exception DOCUMENT ME!
*/
public static void main(final String[] args) throws Exception {
java.awt.EventQueue.invokeLater(new Runnable() {
@@ -321,7 +321,7 @@ public void run() {
}
/**
- * Decrypts String
with BlowfishEasy
+ * Decrypts String
with BlowfishEasy.
*
* @param code String
that should get decrypted
*
@@ -429,10 +429,10 @@ public static char[] encrypt(final char[] string, final boolean wipeInput) throw
}
/**
- * Decrypts a given string that was created by {@link #encrypt(char[])}. The caller is responsible for wiping the
- * returned result himself. The given array can automatically be wiped by passing true
to the
- * wipeInput
parameter. All temporary created data is immediately wiped, thus this implementation offers as
- * little traces in memory as possible.
+ * Decrypts a given string that was created by {@link #encrypt(char[], boolean)}. The caller is responsible for
+ * wiping the returned result himself. The given array can automatically be wiped by passing true
to
+ * the wipeInput
parameter. All temporary created data is immediately wiped, thus this implementation
+ * offers as little traces in memory as possible.
*
* NOTE: this operation can decrypt strings created by {@link #decryptString(java.lang.String)}, too, for
* compatibility reasons
@@ -527,7 +527,7 @@ public static char[] decrypt(final char[] string, final boolean wipeInput) throw
}
/**
- * Applies Cipher
+ * Applies Cipher.
*
* @param bytes string
* @param mode mode
@@ -570,15 +570,15 @@ private static byte[] applyCipher(final byte[] bytes, final int mode) {
}
/**
- * Getter for Master Password
+ * Getter for Master Password.
*
* @return masterpassword as Char[]
*
* @throws PasswordEncrypterException
- *
- * - PasswordEncrypter properties not present.
- * - cannot read master password from properties, not set?
- *
+ *
+ * - PasswordEncrypter properties not present.
+ * - cannot read master password from properties, not set?
+ *
*/
private static char[] getMasterPw() throws PasswordEncrypterException {
final InputStream peStream = PasswordEncrypter.class.getResourceAsStream("PasswordEncrypter.properties"); // NOI18N
@@ -608,14 +608,12 @@ private static char[] getMasterPw() throws PasswordEncrypterException {
}
/**
- * Get Salt.Always 8 bytes.
- * Uses Default Salt, if Salt not set.
- * If Salt is shorter then eight bytes the rest of the Salt will filled with default Salt.
- * If Salt is too long, returns only the first eight bytes
+ * Get Salt.Always 8 bytes. Uses Default Salt, if Salt not set. If Salt is shorter then eight bytes the rest of the
+ * Salt will filled with default Salt. If Salt is too long, returns only the first eight bytes
*
* @return salt
*
- * @throws PasswordEncrypterException PasswordEncrypter properties not present
+ * @throws PasswordEncrypterException PasswordEncrypter properties not present
*/
private static byte[] getSalt() throws PasswordEncrypterException {
final InputStream peStream = PasswordEncrypter.class.getResourceAsStream("PasswordEncrypter.properties"); // NOI18N
@@ -846,7 +844,7 @@ public static byte[] safeRead(final InputStream propertyStream, final char[] pro
//~ Inner Classes ----------------------------------------------------------
/**
- * FocusTraversalOrder
+ * FocusTraversalOrder.
*
* @version $Revision$, $Date$
*/
@@ -873,13 +871,13 @@ public FocusTraversalOrder() {
//~ Methods ------------------------------------------------------------
/**
- * Returns the following Component
of the specified Component
- * If the specified Component
is the Last, Returns the First Component
- *
- * @param aContainer Container
- * @param aComponent Component
- *
- * @return following Component
+ * Returns the following Component
of the specified Component
If the specified
+ * Component
is the Last, Returns the First Component.
+ *
+ * @param aContainer Container
+ * @param aComponent Component
+ *
+ * @return following Component
*/
@Override
public Component getComponentAfter(final Container aContainer, final Component aComponent) {
@@ -887,15 +885,15 @@ public Component getComponentAfter(final Container aContainer, final Component a
return order.get(index);
}
-
+
/**
- * Returns the previous Component
of the specified Component
- * If the specified Component
is the First, Returns the Last Component
- *
- * @param aContainer Container
- * @param aComponent Component
- *
- * @return previous Component
+ * Returns the previous Component
of the specified Component
If the specified
+ * Component
is the First, Returns the Last Component.
+ *
+ * @param aContainer Container
+ * @param aComponent Component
+ *
+ * @return previous Component
*/
@Override
public Component getComponentBefore(final Container aContainer, final Component aComponent) {
@@ -908,11 +906,11 @@ public Component getComponentBefore(final Container aContainer, final Component
}
/**
- * Returns the First Component
- *
- * @param aContainer Container
- *
- * @return Component
+ * Returns the First Component.
+ *
+ * @param aContainer Container
+ *
+ * @return Component
*/
@Override
public Component getFirstComponent(final Container aContainer) {
@@ -920,23 +918,23 @@ public Component getFirstComponent(final Container aContainer) {
}
/**
- * Returns the Last Component
- *
- * @param aContainer Container
- *
- * @return Component
+ * Returns the Last Component.
+ *
+ * @param aContainer Container
+ *
+ * @return Component
*/
@Override
public Component getLastComponent(final Container aContainer) {
return order.get(order.size() - 1);
}
- /**
- * Returns the First Component
- *
- * @param aContainer Container
- *
- * @return Component
+ /**
+ * Returns the First Component.
+ *
+ * @param aContainer Container
+ *
+ * @return Component
*/
@Override
public Component getDefaultComponent(final Container aContainer) {
@@ -945,7 +943,7 @@ public Component getDefaultComponent(final Container aContainer) {
}
/**
- * Code Focus Listener
+ * Code Focus Listener.
*
* @version $Revision$, $Date$
*/
@@ -959,10 +957,10 @@ private final class CodeFocusListener implements FocusListener {
//~ Methods ------------------------------------------------------------
/**
- * Sets the Focus on txaCode
from selStart
to selEnd
- * If the Selected Area is Empty, Selects all.
- *
- * @param e Event
+ * Sets the Focus on txaCode
from selStart
to selEnd
If the Selected Area
+ * is Empty, Selects all.
+ *
+ * @param e Event
*/
@Override
public void focusGained(final FocusEvent e) {
@@ -976,9 +974,10 @@ public void focusGained(final FocusEvent e) {
}
/**
- * Gets the Focus on txaCode
and saves the Start to selStart
and the End to selEnd
- *
- * @param e Event
+ * Gets the Focus on txaCode
and saves the Start to selStart
and the End to
+ * selEnd.
+ *
+ * @param e Event
*/
@Override
public void focusLost(final FocusEvent e) {
diff --git a/src/main/java/de/cismet/tools/PasswordEncrypterException.java b/src/main/java/de/cismet/tools/PasswordEncrypterException.java
index bb9506e..6e70ce3 100644
--- a/src/main/java/de/cismet/tools/PasswordEncrypterException.java
+++ b/src/main/java/de/cismet/tools/PasswordEncrypterException.java
@@ -8,7 +8,7 @@
package de.cismet.tools;
/**
- * Password Encrypter Exception
+ * Password Encrypter Exception.
*
* @author martin.scholl@cismet.de
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/PropertyEqualsProvider.java b/src/main/java/de/cismet/tools/PropertyEqualsProvider.java
index 5a7271a..835273b 100644
--- a/src/main/java/de/cismet/tools/PropertyEqualsProvider.java
+++ b/src/main/java/de/cismet/tools/PropertyEqualsProvider.java
@@ -24,7 +24,7 @@
package de.cismet.tools;
/**
- * Property Equals Provider
+ * Property Equals Provider.
*
* @author thorsten
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/PropertyReader.java b/src/main/java/de/cismet/tools/PropertyReader.java
index ee26466..f9240d8 100644
--- a/src/main/java/de/cismet/tools/PropertyReader.java
+++ b/src/main/java/de/cismet/tools/PropertyReader.java
@@ -18,7 +18,7 @@
import java.util.Properties;
/**
- * Property Reader
+ * Property Reader.
*
* @author srichter
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/ScriptRunner.java b/src/main/java/de/cismet/tools/ScriptRunner.java
index 9c328b7..d741997 100644
--- a/src/main/java/de/cismet/tools/ScriptRunner.java
+++ b/src/main/java/de/cismet/tools/ScriptRunner.java
@@ -69,7 +69,7 @@ public class ScriptRunner {
* Default constructor.
*
* @param connection Connection
- * @param autoCommit Enables/Disables autoCommit
+ * @param autoCommit Enables/Disables autoCommit
* @param stopOnError Enables/Disables stopOnError
*/
public ScriptRunner(final Connection connection, final boolean autoCommit, final boolean stopOnError) {
@@ -81,7 +81,7 @@ public ScriptRunner(final Connection connection, final boolean autoCommit, final
//~ Methods ----------------------------------------------------------------
/**
- * Setter for delimiter
property
+ * Setter for delimiter
property.
*
* @param delimiter new vslue of the delimiter
property
*/
@@ -307,7 +307,7 @@ private boolean evenQuotes(final String s) {
}
/**
- * Gettter for delimiter
+ * Gettter for delimiter.
*
* @return delimiter
*/
@@ -316,7 +316,7 @@ private String getDelimiter() {
}
/**
- * If logWriter is Empty print the Object in System Console
+ * If logWriter is Empty print the Object in System Console.
*
* >>>>>>> .r4704
*
@@ -353,7 +353,7 @@ private void printlnError(final Object o) {
}
/**
- * Flushes the Streams
+ * Flushes the Streams.
*/
private void flush() {
if (logWriter != null) {
diff --git a/src/main/java/de/cismet/tools/Sorter.java b/src/main/java/de/cismet/tools/Sorter.java
index c12053e..4a42d6a 100644
--- a/src/main/java/de/cismet/tools/Sorter.java
+++ b/src/main/java/de/cismet/tools/Sorter.java
@@ -7,7 +7,7 @@
****************************************************/
package de.cismet.tools;
/**
- * Sorter Tool
+ * Sorter Tool.
*
* @version $Revision$, $Date$
*/
@@ -40,11 +40,12 @@ private static boolean isSorted(final Comparable[] array) {
}
/**
- * Sorts the specified Array
with insertionSort
. The Complete Array
is searched.
+ * Sorts the specified Array
with insertionSort
. The Complete Array
is
+ * searched.
*
* @param array Array
, which is going to get sorted
- *
- * @see #insertionSort(java.lang.Comparable[], int, int)
+ *
+ * @see #insertionSort(java.lang.Comparable[], int, int)
*/
public static void insertionSort(final Comparable[] array) {
insertionSort(array, 0, array.length - 1);
@@ -52,11 +53,10 @@ public static void insertionSort(final Comparable[] array) {
/**
* Sorts the specified Array
with insertionSort
. Sorts only a specified area.
- *
- * @param array Array
, which is going to get sorted
- * @param left left end of the area, which is going to get sorted
- * @param right right end of the area, which is going to get sorted
- *
+ *
+ * @param array Array
, which is going to get sorted
+ * @param left left end of the area, which is going to get sorted
+ * @param right right end of the area, which is going to get sorted
*/
public static void insertionSort(final Comparable[] array, final int left, final int right) {
int in;
@@ -79,17 +79,17 @@ public static void insertionSort(final Comparable[] array, final int left, final
//----------------------------------------------------------------------------------------------------------
/**
- * Sorts the specified Array
with Quicksort
.Sorts only a specified area.
- * If the to be sorted area is smaller than or equal partitionSize, InsertionSort
will be used.
+ * Sorts the specified Array
with Quicksort
.Sorts only a specified area. If the to be
+ * sorted area is smaller than or equal partitionSize, InsertionSort
will be used.
*
* @param array Array
, which is going to get sorted.
* @param left left end of the area, which is going to get sorted
* @param right right end of the area, which is going to get sorted
* @param partitionSize minimal size for using Quicksort
- *
- * @see #insertionSort(java.lang.Comparable[], int, int)
- * @see #partitionIt(java.lang.Comparable[], int, int, java.lang.Object)
- * @see #swap(java.lang.Object[], int, int)
+ *
+ * @see #insertionSort(java.lang.Comparable[], int, int)
+ * @see #partitionIt(java.lang.Comparable[], int, int, java.lang.Object)
+ * @see #swap(java.lang.Object[], int, int)
*/
private static void quickSort(final Comparable[] array, final int left, final int right, final int partitionSize) {
@@ -111,32 +111,33 @@ private static void quickSort(final Comparable[] array, final int left, final in
}
/**
- * Sorts the specified Array
with Quicksort
.Sorts the complete Array
.
- * If the to be sorted area is smaller than or equal 16, InsertionSort
will be used.
+ * Sorts the specified Array
with Quicksort
.Sorts the complete Array
. If the
+ * to be sorted area is smaller than or equal 16, InsertionSort
will be used.
*
* @param array Array
, which is going to get sorted.
- *
- * @see #quickSort(java.lang.Comparable[], int, int, int)
+ *
+ * @see #quickSort(java.lang.Comparable[], int, int, int)
*/
public static void quickSort(final Comparable[] array) {
quickSort(array, 0, array.length - 1, 16); // no insertion when partition >=16
}
/**
- * Divides into two Sets
+ * Divides into two Sets.
+ *
*
- * - all Elements which are smaller than the Rightmost
- * - all Elements which are bigger than the Rightmost
+ * - all Elements which are smaller than the Rightmost
+ * - all Elements which are bigger than the Rightmost
*
*
- * @param array Array, which is going to get Sorted
+ * @param array Array
, which is going to get Sorted
* @param left left end of the area, which is going to get sorted
* @param right right end of the area, which is going to get sorted
* @param pivot Rightmost
*
* @return Location of the Rightmost after the Sorting
- *
- * @see #quickSort(java.lang.Comparable[], int, int, int)
- * @see #swap(java.lang.Object[], int, int)
+ *
+ * @see #quickSort(java.lang.Comparable[], int, int, int)
+ * @see #swap(java.lang.Object[], int, int)
*/
private static int partitionIt(final Comparable[] array, final int left, final int right, final Object pivot) {
int leftPtr = left - 1;
@@ -166,14 +167,14 @@ private static int partitionIt(final Comparable[] array, final int left, final i
//----------------------------------------------------------------------------------------------
/**
- * swaps two Elements of the specified Array
+ * swaps two Elements of the specified Array.
*
* @param array Array
, which is going to get sorted
* @param i Location of Element one
* @param j Location of Element two
- *
- * @see #quickSort(java.lang.Comparable[], int, int, int)
- * @see #partitionIt(java.lang.Comparable[], int, int, java.lang.Object)
+ *
+ * @see #quickSort(java.lang.Comparable[], int, int, int)
+ * @see #partitionIt(java.lang.Comparable[], int, int, java.lang.Object)
*/
private static void swap(final Object[] array, final int i, final int j) {
diff --git a/src/main/java/de/cismet/tools/StaticDebuggingTools.java b/src/main/java/de/cismet/tools/StaticDebuggingTools.java
index 8160b2f..f431f05 100644
--- a/src/main/java/de/cismet/tools/StaticDebuggingTools.java
+++ b/src/main/java/de/cismet/tools/StaticDebuggingTools.java
@@ -18,7 +18,7 @@
import java.io.File;
/**
- * StaticDebuggingTools
+ * StaticDebuggingTools.
*
* @author cschmidt
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/StaticDecimalTools.java b/src/main/java/de/cismet/tools/StaticDecimalTools.java
index 6da4fb5..6e89a5c 100644
--- a/src/main/java/de/cismet/tools/StaticDecimalTools.java
+++ b/src/main/java/de/cismet/tools/StaticDecimalTools.java
@@ -23,8 +23,8 @@ public class StaticDecimalTools {
* @param d Double
which should be rounded
*
* @return the rounded Double
- *
- * @see #round(java.lang.String, double)
+ *
+ * @see #round(java.lang.String, double)
*/
public static String round(final double d) {
return round("0.00", d); // NOI18N
diff --git a/src/main/java/de/cismet/tools/StaticHtmlTools.java b/src/main/java/de/cismet/tools/StaticHtmlTools.java
index 390f31d..4b50e79 100644
--- a/src/main/java/de/cismet/tools/StaticHtmlTools.java
+++ b/src/main/java/de/cismet/tools/StaticHtmlTools.java
@@ -12,7 +12,7 @@
import java.net.URLEncoder;
/**
- * StaticHtmlTools
+ * StaticHtmlTools.
*
* @author thorsten.hell@cismet.de
* @version $Revision$, $Date$
@@ -122,7 +122,7 @@ public static String stripMetaTag(final String text) {
}
/**
- * main
+ * main.
*
* @param args args
*/
diff --git a/src/main/java/de/cismet/tools/StaticXMLTools.java b/src/main/java/de/cismet/tools/StaticXMLTools.java
index 688dab2..3317f37 100644
--- a/src/main/java/de/cismet/tools/StaticXMLTools.java
+++ b/src/main/java/de/cismet/tools/StaticXMLTools.java
@@ -17,7 +17,7 @@
import java.awt.Font;
/**
- * Static XML Tools
+ * Static XML Tools.
*
* @author thorsten
* @version $Revision$, $Date$
@@ -55,7 +55,7 @@ public static Element convertColorToXML(final Color c) {
}
/**
- * Converts the specified XMLElement
into a Color
+ * Converts the specified XMLElement
into a Color.
*
* @param xmlElement xmlElemt
, which is going to be converted
*
@@ -89,7 +89,7 @@ public static Color convertXMLElementToColor(final Element xmlElement) {
}
/**
- * Converts the Font
into XML-Code
+ * Converts the Font
into XML-Code.
*
* @param f Font
, which is going to be converted
*
@@ -104,7 +104,7 @@ public static Element convertFontToXML(final Font f) {
}
/**
- * Converts XMLElement
into Font
+ * Converts XMLElement
into Font.
*
* @param xmlElement xmlElement
, which is going to be converted
*
diff --git a/src/main/java/de/cismet/tools/StringTools.java b/src/main/java/de/cismet/tools/StringTools.java
index 605eeb9..87023ca 100644
--- a/src/main/java/de/cismet/tools/StringTools.java
+++ b/src/main/java/de/cismet/tools/StringTools.java
@@ -13,7 +13,7 @@
package de.cismet.tools;
/**
- * String Tools
+ * String Tools.
*
* @author schlob
* @version $Revision$, $Date$
@@ -31,7 +31,7 @@ private StringTools() {
//~ Methods ----------------------------------------------------------------
/**
- * Deletes Whitspaces in the String
+ * Deletes Whitspaces in the String.
*
* @param string String
, which is going to get cleaned
*
diff --git a/src/main/java/de/cismet/tools/TextFromFile.java b/src/main/java/de/cismet/tools/TextFromFile.java
index 5b70dd2..f50f7cc 100644
--- a/src/main/java/de/cismet/tools/TextFromFile.java
+++ b/src/main/java/de/cismet/tools/TextFromFile.java
@@ -11,7 +11,7 @@
import java.util.*;
/**
- * Class for getting Text from File
+ * Class for getting Text from File.
*
* @version $Revision$, $Date$
*/
@@ -33,7 +33,7 @@ public TextFromFile() {
}
/**
- * Creates a new TextFromFile object from file
with specified filepath
+ * Creates a new TextFromFile object from file
with specified filepath.
*
* @param filepath filepath
*/
diff --git a/src/main/java/de/cismet/tools/TimeoutThread.java b/src/main/java/de/cismet/tools/TimeoutThread.java
index 5098171..9f168dc 100644
--- a/src/main/java/de/cismet/tools/TimeoutThread.java
+++ b/src/main/java/de/cismet/tools/TimeoutThread.java
@@ -47,8 +47,8 @@ public TimeoutThread() {
*
* @return result
*
- * @throws Exception
- * @throws TimeoutException
+ * @throws Exception DOCUMENT ME!
+ * @throws TimeoutException DOCUMENT ME!
*/
public T start(final long timeInMillis) throws Exception {
final Thread t = new Thread(this);
diff --git a/src/main/java/de/cismet/tools/URLSplitter.java b/src/main/java/de/cismet/tools/URLSplitter.java
index 7a093c3..29e3bcd 100644
--- a/src/main/java/de/cismet/tools/URLSplitter.java
+++ b/src/main/java/de/cismet/tools/URLSplitter.java
@@ -8,7 +8,7 @@
package de.cismet.tools;
/**
- * Urlsplitter
+ * Urlsplitter.
*
* @author thorsten.hell@cismet.de
* @version $Revision$, $Date$
@@ -85,7 +85,7 @@ private URLSplitter() {
//~ Methods ----------------------------------------------------------------
/**
- * Getter for prot_prefix
+ * Getter for prot_prefix.
*
* @return prot_prefix
*/
@@ -94,7 +94,7 @@ public String getProt_prefix() {
}
/**
- * Getter for server
+ * Getter for server.
*
* @return server
*/
@@ -103,7 +103,7 @@ public String getServer() {
}
/**
- * Getter for path
+ * Getter for path.
*
* @return path
*/
@@ -112,7 +112,7 @@ public String getPath() {
}
/**
- * Getter for object_name
+ * Getter for object_name.
*
* @return object_name
*/
@@ -122,14 +122,14 @@ public String getObject_name() {
/**
* returns a String
, which has the following form
- * Prot: {@link #prot_prefix}
+ * Prot: {@link #prot_prefix}
* Server: {@link #server}
- * Path: {@link #path}
+ * Path: {@link #path}
* Objekt: {@link #object_name}
- *
- * @return String
+ *
+ * @return String
*/
-
+
@Override
public String toString() {
return "Prot: " + prot_prefix + "\n" // NOI18N
@@ -139,7 +139,7 @@ public String toString() {
}
/**
- * main
+ * main.
*
* @param args args
*/
From 1d4fd837a45deee879f6b36d47f94fcfeccc9abb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Tue, 8 Jan 2013 18:44:36 +0100
Subject: [PATCH 19/34] #9 Java Doc Improvements of
StaticGeometryFunctions.java,Proxy.java and TunnelTargetGroup.java
---
.../geometry/StaticGeometryFunctions.java | 24 +++++++++----------
src/main/java/de/cismet/netutil/Proxy.java | 4 ++--
.../netutil/tunnel/TunnelTargetGroup.java | 2 +-
3 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/src/main/java/de/cismet/math/geometry/StaticGeometryFunctions.java b/src/main/java/de/cismet/math/geometry/StaticGeometryFunctions.java
index be6d6d0..9620b17 100644
--- a/src/main/java/de/cismet/math/geometry/StaticGeometryFunctions.java
+++ b/src/main/java/de/cismet/math/geometry/StaticGeometryFunctions.java
@@ -10,7 +10,7 @@
import java.awt.geom.Point2D;
/**
- * DOCUMENT ME!
+ * Geometry Functions.
*
* @author thorsten.hell@cismet.de
* @version $Revision$, $Date$
@@ -20,14 +20,14 @@ public class StaticGeometryFunctions {
//~ Methods ----------------------------------------------------------------
/**
- * Berechnet den Lotpunkt des Triggers auf der Gerade durch lineStart und lineEnd. !!! Momentan kann der Punkt NICHT
- * \u00FCber die Strecke hinaus verschoben werden !!!
+ * Calculates Perpendicular Point of the Trigger on the Line, which goes through lineStart and lineEnd. !Warning:
+ * Can't move the Point over the Line, yet.
*
- * @param lineStart Anfangspunkt der Gerade
- * @param lineEnd Endpunkt der Gerade
- * @param trigger Punkt zu dem der Lotpunkt auf der Geraden berechnet wird
+ * @param lineStart startPoint of the Line
+ * @param lineEnd endPoint of the Line
+ * @param trigger Point to which the Perpendicular Point will get calculated
*
- * @return Punkt auf der Geraden
+ * @return Perpendicular Point on the Line
*/
public static Point2D createPointOnLine(final Point2D lineStart, final Point2D lineEnd, final Point2D trigger) {
final double maxX = Math.max(lineStart.getX(), lineEnd.getX());
@@ -71,13 +71,13 @@ public static Point2D createPointOnLine(final Point2D lineStart, final Point2D l
}
/**
- * Berechnet den Abstand eines Punktes von der Geraden durch lineStart und lineEnd.
+ * Calculates the Distance between a specified Point and a specified Line, which goes through lineStart and lineEnd.
*
- * @param lineStart Anfangspunkt der Gerade
- * @param lineEnd Endpunkt der Gerade
- * @param trigger Punkt dessen Abstand zur Geraden berechnet werden soll
+ * @param lineStart startPoint of the Line
+ * @param lineEnd endPoint of the Line
+ * @param trigger Point, whose distance to the Line should get Calculated
*
- * @return Abstand vom Punkt zur Geraden
+ * @return Distance between the Point and the Line
*/
public static double distanceToLine(final Point2D lineStart, final Point2D lineEnd, final Point2D trigger) {
final Point2D pointOnLine = createPointOnLine(lineStart, lineEnd, trigger);
diff --git a/src/main/java/de/cismet/netutil/Proxy.java b/src/main/java/de/cismet/netutil/Proxy.java
index 30d96e7..b1ad74f 100644
--- a/src/main/java/de/cismet/netutil/Proxy.java
+++ b/src/main/java/de/cismet/netutil/Proxy.java
@@ -16,7 +16,7 @@
import de.cismet.tools.PasswordEncrypter;
/**
- * DOCUMENT ME!
+ * Proxy Class.
*
* @author spuhl
* @author martin.scholl@cismet.de
@@ -146,7 +146,7 @@ public void setPort(final int port) {
}
/**
- * return as String.
+ * Return as String.
*
* @return "Proxy: " + host
+ ":" + port
+ " | username: " + username
+" |
* password: " + ((password
== null
) ? null
: "") + " |
diff --git a/src/main/java/de/cismet/netutil/tunnel/TunnelTargetGroup.java b/src/main/java/de/cismet/netutil/tunnel/TunnelTargetGroup.java
index f92151b..4d9d32a 100644
--- a/src/main/java/de/cismet/netutil/tunnel/TunnelTargetGroup.java
+++ b/src/main/java/de/cismet/netutil/tunnel/TunnelTargetGroup.java
@@ -14,7 +14,7 @@
import org.codehaus.jackson.map.ObjectMapper;
/**
- * DOCUMENT ME!
+ * TunnelTargetGroup Class.
*
* @author thorsten
* @version $Revision$, $Date$
From f4a13fec1f8e0cdf48758d61ecd02ffa5fed4b10 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Tue, 8 Jan 2013 18:45:33 +0100
Subject: [PATCH 20/34] #9 Java Doc Improvements of Package de.cismet.remote
---
.../java/de/cismet/remote/AbstractRESTRemoteControlMethod.java | 2 +-
src/main/java/de/cismet/remote/RESTRemoteControlMethod.java | 2 +-
.../java/de/cismet/remote/RESTRemoteControlMethodRegistry.java | 2 +-
.../de/cismet/remote/RESTRemoteControlMethodsApplication.java | 2 +-
4 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/main/java/de/cismet/remote/AbstractRESTRemoteControlMethod.java b/src/main/java/de/cismet/remote/AbstractRESTRemoteControlMethod.java
index c7bfa7e..f1d135e 100644
--- a/src/main/java/de/cismet/remote/AbstractRESTRemoteControlMethod.java
+++ b/src/main/java/de/cismet/remote/AbstractRESTRemoteControlMethod.java
@@ -8,7 +8,7 @@
package de.cismet.remote;
/**
- * DOCUMENT ME!
+ * AbstractRestRemoteControlMethod Class.
*
* @author Benjamin Friedrich (benjamin.friedrich@cismet.de)
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/remote/RESTRemoteControlMethod.java b/src/main/java/de/cismet/remote/RESTRemoteControlMethod.java
index 2dfeef3..8f9e224 100644
--- a/src/main/java/de/cismet/remote/RESTRemoteControlMethod.java
+++ b/src/main/java/de/cismet/remote/RESTRemoteControlMethod.java
@@ -8,7 +8,7 @@
package de.cismet.remote;
/**
- * DOCUMENT ME!
+ * RestRemoteControlMethod Interface.
*
* @author Benjamin Friedrich (benjamin.friedrich@cismet.de)
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/remote/RESTRemoteControlMethodRegistry.java b/src/main/java/de/cismet/remote/RESTRemoteControlMethodRegistry.java
index 659f0e6..4cff32e 100644
--- a/src/main/java/de/cismet/remote/RESTRemoteControlMethodRegistry.java
+++ b/src/main/java/de/cismet/remote/RESTRemoteControlMethodRegistry.java
@@ -12,7 +12,7 @@
import java.util.*;
/**
- * DOCUMENT ME!
+ * RESTRemoteControlMethodRegistry Class.
*
* @author bfriedrich
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/remote/RESTRemoteControlMethodsApplication.java b/src/main/java/de/cismet/remote/RESTRemoteControlMethodsApplication.java
index 3595bc5..bb72806 100644
--- a/src/main/java/de/cismet/remote/RESTRemoteControlMethodsApplication.java
+++ b/src/main/java/de/cismet/remote/RESTRemoteControlMethodsApplication.java
@@ -18,7 +18,7 @@
import javax.ws.rs.core.Context;
/**
- * DOCUMENT ME!
+ * RESTRemoteControlMethodsApplication.
*
* @author bfriedrich
* @version $Revision$, $Date$
From e8034780ac28b0207d08402c743e4456c0a53c73 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Tue, 8 Jan 2013 18:46:11 +0100
Subject: [PATCH 21/34] #9 Java Doc Improvements of Package
de.cismet.tools.configuration
---
.../tools/collections/HashArrayList.java | 142 +++++++++++++++++-
.../configuration/ConfigAttrProvider.java | 2 +-
.../tools/configuration/Configurable.java | 2 +-
.../configuration/ConfigurationManager.java | 46 ++++--
.../tools/configuration/NoWriteError.java | 2 +-
5 files changed, 170 insertions(+), 24 deletions(-)
diff --git a/src/main/java/de/cismet/tools/collections/HashArrayList.java b/src/main/java/de/cismet/tools/collections/HashArrayList.java
index 4b1947a..5b7212f 100644
--- a/src/main/java/de/cismet/tools/collections/HashArrayList.java
+++ b/src/main/java/de/cismet/tools/collections/HashArrayList.java
@@ -12,7 +12,7 @@
import java.util.HashSet;
/**
- * DOCUMENT ME!
+ * Modified {@link ArrayList} Class, which contains an additional Hashset.
*
* @author thorsten
* @version $Revision$, $Date$
@@ -21,6 +21,9 @@ public class HashArrayList extends ArrayList {
//~ Instance fields --------------------------------------------------------
+ /**
+ * @see HashSet
+ */
HashSet containsMarkerSet = new HashSet();
//~ Constructors -----------------------------------------------------------
@@ -32,9 +35,9 @@ public HashArrayList() {
}
/**
- * Creates a new HashArrayList object.
+ * Creates a new HashArrayList object from a specified Collection
.
*
- * @param c DOCUMENT ME!
+ * @param c Collection
*/
public HashArrayList(final Collection extends E> c) {
super(c);
@@ -44,9 +47,9 @@ public HashArrayList(final Collection extends E> c) {
}
/**
- * Creates a new HashArrayList object.
+ * Constructs an empty HashArrayList with the specified initial capacity.
*
- * @param initialCapacity DOCUMENT ME!
+ * @param initialCapacity the initial capacity of the list
*/
public HashArrayList(final int initialCapacity) {
super(initialCapacity);
@@ -54,59 +57,167 @@ public HashArrayList(final int initialCapacity) {
//~ Methods ----------------------------------------------------------------
+ /**
+ * Appends the specified Element
to the end of Arraylist
and adds the specified
+ * Element
to the HashSet
if it is not already present.
+ *
+ * @param e Element, which should get append
+ *
+ * @return True
+ *
+ * @see ArrayList#add(java.lang.Object)
+ * @see HashSet#add(java.lang.Object)
+ */
@Override
public boolean add(final E e) {
containsMarkerSet.add(e);
return super.add(e);
}
+ /**
+ * Appends the specified Element
to the specified index
.Shifts the element currently at
+ * that position (if any) and any subsequent elements to the right (adds one to their indices). Adds the specified
+ * element
to the HashSet
if it is not already present.
+ *
+ * @param index index, where the Element should be placed to
+ * @param element Element to be appended
+ *
+ * @see ArrayList#add(int, java.lang.Object)
+ * @see HashSet#add(java.lang.Object)
+ */
@Override
public void add(final int index, final E element) {
containsMarkerSet.add(element);
super.add(index, element);
}
+ /**
+ * This implementation iterates
over the specified Collection
, and adds each object
+ * returned by the iterator
to this collection
, in turn. Appends the new Objects to the
+ * end of the ArrayList
+ *
+ * @param c Collection
+ *
+ * @return true
if this list changed as a result of the call
+ *
+ * @see ArrayList#addAll(java.util.Collection)
+ * @see HashSet#addAll(java.util.Collection)
+ */
@Override
public boolean addAll(final Collection extends E> c) {
containsMarkerSet.addAll(c);
return super.addAll(c);
}
+ /**
+ * This implementation iterates
over the specified Collection
, and adds each object
+ * returned by the iterator
to this collection
, in turn. Inserts all of the elements in
+ * the specified collection into the ArrayList
, starting at the specified position. Shifts the element
+ * currently at that position.
+ *
+ * @param index startindex
+ * @param c Collection
+ *
+ * @return true
if this list changed as a result of the call
+ *
+ * @see ArrayList#addAll(int, java.util.Collection)
+ * @see HashSet#addAll(java.util.Collection)
+ */
@Override
public boolean addAll(final int index, final Collection extends E> c) {
containsMarkerSet.addAll(c);
return super.addAll(index, c);
}
+ /**
+ * Removes all of the elements from this HashArrayList
. The ArrayList
and the
+ * HashSet
will be empty after this call returns.
+ *
+ * @see ArrayList#clear()
+ * @see HashSet#clear()
+ */
@Override
public void clear() {
containsMarkerSet.clear();
super.clear();
}
+ /**
+ * Clones the HashArrayList.
+ *
+ * @return the cloned HashArrayList
+ */
@Override
public Object clone() {
return new HashArrayList(this);
}
+ /**
+ * Tests whether the ArrayList
contains the specified Object or not.
+ *
+ * @param o Object to be tested
+ *
+ * @return True
, if the ArrayList
contains the specified Object
+ *
+ * @see ArrayList#contains(java.lang.Object)
+ */
@Override
public boolean contains(final Object o) {
// return containsMarkerSet.contains(o);
return super.contains(o);
}
+ /**
+ * Removes the Object on the specified index
. The ArrayList
shifts any subsequent elements
+ * to the left.Removes the element associated with the index in the Hashmap
//Note: If the deleted
+ * Object was multiple time inside the Arraylist
, it could be possible that the Object is inside
+ * ArrayList
, but not in the HashSet
+ *
+ * @param index index, whose Object to be deleted
+ *
+ * @return the Object, that was removed from the HashArrayList
+ *
+ * @see ArrayList#remove(int)
+ * @see HashSet#remove(java.lang.Object)
+ */
@Override
public E remove(final int index) {
containsMarkerSet.remove(get(index));
return super.remove(index);
}
+ /**
+ * Removes the Object on the specified index
. The ArrayList
deletes the first occurrence
+ * of the specified Object and shifts any subsequent elements to the left.Removes the element associated with the
+ * index in the Hashmap
//Note: If the deleted Object was multiple time inside the
+ * Arraylist
, it could be possible that the Object is inside ArrayList
, but not in the
+ * HashSet
+ *
+ * @param o Object to be deleted
+ *
+ * @return the Object, that was removed from the HashArrayList
+ *
+ * @see ArrayList#remove(java.lang.Object)
+ * @see HashSet#remove(java.lang.Object)
+ */
@Override
public boolean remove(final Object o) {
containsMarkerSet.remove(o);
return super.remove(o);
}
+ /**
+ * Removes the Object on the index
within the specified range. The ArrayList
shifts any
+ * subsequent elements to the left.Removes the element associated with the index in the Hashmap
//Note:
+ * If the deleted Object was multiple time inside the Arraylist
, it could be possible that the Object
+ * is inside ArrayList
, but not in the HashSet
+ *
+ * @param fromIndex Start IndexRange
+ * @param toIndex End IndexRange
+ *
+ * @see ArrayList#removeRange(int, int)
+ * @see HashSet#remove(java.lang.Object)
+ */
@Override
protected void removeRange(final int fromIndex, final int toIndex) {
for (int i = fromIndex; i <= toIndex; ++i) {
@@ -115,6 +226,17 @@ protected void removeRange(final int fromIndex, final int toIndex) {
super.removeRange(fromIndex, toIndex);
}
+ /**
+ * Replaces the element at the specified position in this ArrayList
with the specified element. Removes
+ * the element associated with the index in the Hashmap
and adds the element.
+ *
+ * @param index index, whose element to be replaced
+ * @param element element
+ *
+ * @return the element previously at the specified position
+ *
+ * @see ArrayList#set(int, java.lang.Object)
+ */
@Override
public E set(final int index, final E element) {
containsMarkerSet.remove(get(index));
@@ -122,6 +244,16 @@ public E set(final int index, final E element) {
return super.set(index, element);
}
+ /**
+ * Removes all elements contained in the specified Collection.
+ *
+ * @param c Collection
+ *
+ * @return true
if this HashArrayList
changed as a result of the call
+ *
+ * @see ArrayList#removeAll(java.util.Collection)
+ * @see HashSet#removeAll(java.util.Collection)
+ */
@Override
public boolean removeAll(final Collection> c) {
containsMarkerSet.removeAll(c);
diff --git a/src/main/java/de/cismet/tools/configuration/ConfigAttrProvider.java b/src/main/java/de/cismet/tools/configuration/ConfigAttrProvider.java
index 96bf26d..e3183f6 100644
--- a/src/main/java/de/cismet/tools/configuration/ConfigAttrProvider.java
+++ b/src/main/java/de/cismet/tools/configuration/ConfigAttrProvider.java
@@ -8,7 +8,7 @@
package de.cismet.tools.configuration;
/**
- * DOCUMENT ME!
+ * ConfigAttriProvider Interface.
*
* @author martin.scholl@cismet.de
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/configuration/Configurable.java b/src/main/java/de/cismet/tools/configuration/Configurable.java
index fec9d73..4c3aef9 100644
--- a/src/main/java/de/cismet/tools/configuration/Configurable.java
+++ b/src/main/java/de/cismet/tools/configuration/Configurable.java
@@ -10,7 +10,7 @@
import org.jdom.Element;
/**
- * DOCUMENT ME!
+ * Configurable Interface.
*
* @author thorsten.hell@cismet.de
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java b/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java
index 5c1936f..c15d106 100644
--- a/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java
+++ b/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java
@@ -93,54 +93,54 @@ public ConfigurationManager() {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * Appends specified Configurable
to the list {@link #configurables}.
*
- * @param configurable DOCUMENT ME!
+ * @param configurable Configurable
, which should get append to the List
*/
public void addConfigurable(final Configurable configurable) {
configurables.add(configurable);
}
/**
- * DOCUMENT ME!
+ * Removes specified Configurable
from the list {@link #configurables}.
*
- * @param configurable DOCUMENT ME!
+ * @param configurable Configurable
, which should get removed from the List
*/
public void removeConfigurable(final Configurable configurable) {
configurables.remove(configurable);
}
/**
- * DOCUMENT ME!
+ * Getter for fileName.
*
- * @return DOCUMENT ME!
+ * @return {@link #fileName}
*/
public String getFileName() {
return fileName;
}
/**
- * DOCUMENT ME!
+ * Setter for fileName.
*
- * @param fileName DOCUMENT ME!
+ * @param fileName {@link #fileName}
*/
public void setFileName(final String fileName) {
this.fileName = fileName;
}
/**
- * DOCUMENT ME!
+ * Getter for folder.
*
- * @return DOCUMENT ME!
+ * @return {@link #folder}
*/
public String getFolder() {
return folder;
}
/**
- * DOCUMENT ME!
+ * Setter for folder.
*
- * @param folder DOCUMENT ME!
+ * @param folder {@link #folder}
*/
public void setFolder(final String folder) {
this.folder = folder;
@@ -148,6 +148,8 @@ public void setFolder(final String folder) {
/**
* DOCUMENT ME!
+ *
+ * @see #configure(de.cismet.tools.configuration.Configurable)
*/
public void configure() {
configure((Configurable)null);
@@ -157,6 +159,8 @@ public void configure() {
* DOCUMENT ME!
*
* @param path DOCUMENT ME!
+ *
+ * @see #configure(de.cismet.tools.configuration.Configurable, java.lang.String)
*/
public void configure(final String path) {
configure(null, path);
@@ -166,6 +170,8 @@ public void configure(final String path) {
* DOCUMENT ME!
*
* @param singleConfig DOCUMENT ME!
+ *
+ * @see #configure(de.cismet.tools.configuration.Configurable, java.lang.String)
*/
public void configure(final Configurable singleConfig) {
configure(singleConfig, home + fs + folder + fs + fileName);
@@ -176,6 +182,8 @@ public void configure(final Configurable singleConfig) {
*
* @param singleConfig DOCUMENT ME!
* @param path DOCUMENT ME!
+ *
+ * @see #pureConfigure(de.cismet.tools.configuration.Configurable, org.jdom.Element, org.jdom.Element)
*/
public void configure(final Configurable singleConfig, final String path) {
Element rootObject = null;
@@ -215,6 +223,8 @@ public void configure(final Configurable singleConfig, final String path) {
/**
* DOCUMENT ME!
+ *
+ * @see #configureFromClasspath(de.cismet.tools.configuration.Configurable)
*/
public void configureFromClasspath() {
configureFromClasspath(null);
@@ -224,6 +234,8 @@ public void configureFromClasspath() {
* DOCUMENT ME!
*
* @param singleConfig DOCUMENT ME!
+ *
+ * @see #pureConfigure(de.cismet.tools.configuration.Configurable, org.jdom.Element, org.jdom.Element)
*/
public void configureFromClasspath(final Configurable singleConfig) {
final Element rootObject = getRootObjectFromClassPath();
@@ -237,6 +249,8 @@ public void configureFromClasspath(final Configurable singleConfig) {
* @param singleConfig DOCUMENT ME!
*
* @throws Exception DOCUMENT ME!
+ *
+ * @see #pureConfigure(de.cismet.tools.configuration.Configurable, org.jdom.Element, org.jdom.Element)
*/
public void configureFromClasspath(final String url, final Configurable singleConfig) throws Exception {
final Element rootObject = getObjectFromClassPath(url);
@@ -244,7 +258,7 @@ public void configureFromClasspath(final String url, final Configurable singleCo
}
/**
- * DOCUMENT ME!
+ * Initialises the Local Configuration Classpath.
*/
public void initialiseLocalConfigurationClasspath() {
try {
@@ -301,11 +315,11 @@ private Element getRootObjectFromClassPath() {
}
/**
- * DOCUMENT ME!
+ * Gets the object from specified ClassPath.
*
- * @param classPathUrl DOCUMENT ME!
+ * @param classPathUrl Classpath as Url
*
- * @return DOCUMENT ME!
+ * @return Object
*
* @throws JDOMException DOCUMENT ME!
* @throws IOException DOCUMENT ME!
diff --git a/src/main/java/de/cismet/tools/configuration/NoWriteError.java b/src/main/java/de/cismet/tools/configuration/NoWriteError.java
index 0a15f6d..ce4ff28 100644
--- a/src/main/java/de/cismet/tools/configuration/NoWriteError.java
+++ b/src/main/java/de/cismet/tools/configuration/NoWriteError.java
@@ -8,7 +8,7 @@
package de.cismet.tools.configuration;
/**
- * DOCUMENT ME!
+ * unnecessary class, another appropriate exception could be thrown.
*
* @author thorsten.hell@cismet.de
* @version $Revision$, $Date$
From 1fc818fee5f7aa51a70041500dfe76619d6d6c09 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Tue, 8 Jan 2013 18:46:53 +0100
Subject: [PATCH 22/34] #9 Java Doc Improvements of Package de.cismet.veto
---
src/main/java/de/cismet/veto/VetoException.java | 4 ++--
src/main/java/de/cismet/veto/VetoListener.java | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/src/main/java/de/cismet/veto/VetoException.java b/src/main/java/de/cismet/veto/VetoException.java
index bca44c1..3659c57 100644
--- a/src/main/java/de/cismet/veto/VetoException.java
+++ b/src/main/java/de/cismet/veto/VetoException.java
@@ -12,7 +12,7 @@
package de.cismet.veto;
/**
- * DOCUMENT ME!
+ * Veto Exception Class.
*
* @author spuhl
* @version $Revision$, $Date$
@@ -30,7 +30,7 @@ public VetoException() {
/**
* Creates a new VetoException object.
*
- * @param message DOCUMENT ME!
+ * @param message the detail message
*/
public VetoException(final String message) {
super(message);
diff --git a/src/main/java/de/cismet/veto/VetoListener.java b/src/main/java/de/cismet/veto/VetoListener.java
index 00ec84f..647be39 100644
--- a/src/main/java/de/cismet/veto/VetoListener.java
+++ b/src/main/java/de/cismet/veto/VetoListener.java
@@ -12,7 +12,7 @@
package de.cismet.veto;
/**
- * DOCUMENT ME!
+ * Veto Listener interface.
*
* @author spuhl
* @version $Revision$, $Date$
@@ -22,7 +22,7 @@ public interface VetoListener {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * throws Veto Exception.
*
* @throws VetoException DOCUMENT ME!
*/
From 3ef60db0ff0a130f958c03ad366e631e9c103edf Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Wed, 9 Jan 2013 18:48:58 +0100
Subject: [PATCH 23/34] #9 javadoc improvements of packages de.cismet.tools and
de.cimset.tools.configuration
---
src/main/java/de/cismet/ext/CExtContext.java | 29 ++++-
.../cismet/math/delaunytriangulation/Pnt.java | 6 +-
.../math/delaunytriangulation/Simplex.java | 15 +--
.../delaunytriangulation/Triangulation.java | 2 +-
src/main/java/de/cismet/netutil/Proxy.java | 13 +--
src/main/java/de/cismet/tools/Base64.java | 2 +-
.../java/de/cismet/tools/BrowserLauncher.java | 37 ++++---
.../de/cismet/tools/CalculationCache.java | 8 +-
src/main/java/de/cismet/tools/Calculator.java | 2 +-
.../de/cismet/tools/CurrentStackTrace.java | 7 +-
.../java/de/cismet/tools/DebugSwitches.java | 2 +-
src/main/java/de/cismet/tools/FileUtils.java | 2 +-
.../de/cismet/tools/LinkedProperties.java | 102 ++++++++++++------
.../de/cismet/tools/PasswordEncrypter.java | 2 +-
.../java/de/cismet/tools/ScriptRunner.java | 10 ++
src/main/java/de/cismet/tools/Sorter.java | 5 +-
.../de/cismet/tools/StaticDebuggingTools.java | 2 +-
.../java/de/cismet/tools/StaticHtmlTools.java | 2 +-
.../java/de/cismet/tools/StaticXMLTools.java | 2 +-
.../java/de/cismet/tools/StringTools.java | 2 +-
.../java/de/cismet/tools/TextFromFile.java | 2 +-
.../java/de/cismet/tools/TimeoutThread.java | 4 +-
.../java/de/cismet/tools/URLSplitter.java | 14 ++-
.../configuration/ConfigAttrProvider.java | 18 ++--
.../tools/configuration/Configurable.java | 4 +-
.../configuration/ConfigurationManager.java | 46 ++++----
26 files changed, 213 insertions(+), 127 deletions(-)
diff --git a/src/main/java/de/cismet/ext/CExtContext.java b/src/main/java/de/cismet/ext/CExtContext.java
index b3d61bc..9b9c888 100644
--- a/src/main/java/de/cismet/ext/CExtContext.java
+++ b/src/main/java/de/cismet/ext/CExtContext.java
@@ -62,14 +62,31 @@ public CExtContext(final String key, final Object value) {
//~ Methods ----------------------------------------------------------------
/**
- * @see HashMap#put(java.lang.Object, java.lang.Object)
+ * Appends the specified key
with the specified mapping value
to the
+ * propertyBag
. If the specified key
already has an associated value
, this
+ * value
would get removed by the specified value
+ *
+ * @param key the key for the given value
+ * @param value the value for the given key
+ *
+ * @return the previous value associated with key
, or null
if there was no mapping for
+ * the specified key
.
+ *
+ * @see Map#put(java.lang.Object, java.lang.Object)
*/
public Object putProperty(final String key, final Object value) {
return propertyBag.put(key, value);
}
/**
- * @see HashMap#get(java.lang.Object)
+ * Get the associated value
for the specified key.
+ *
+ * @param key the key, whose mapping is searched
+ *
+ * @return the value
for the specified key
, or null
if there was no mapping
+ * for the specified key
.
+ *
+ * @see Map#get(java.lang.Object)
*/
public Object getProperty(final String key) {
return propertyBag.get(key);
@@ -85,7 +102,13 @@ public Map getPropertyBag() {
}
/**
- * @see HashMap#remove(java.lang.Object)
+ * Removes the value
for the specified key
from this map.
+ *
+ * @param key the key, whose mapping is removed
+ *
+ * @return the value
, which is removed
+ *
+ * @see Map#remove(java.lang.Object)
*/
public Object clearProperty(final String key) {
return propertyBag.remove(key);
diff --git a/src/main/java/de/cismet/math/delaunytriangulation/Pnt.java b/src/main/java/de/cismet/math/delaunytriangulation/Pnt.java
index c4c6941..46ff8c2 100644
--- a/src/main/java/de/cismet/math/delaunytriangulation/Pnt.java
+++ b/src/main/java/de/cismet/math/delaunytriangulation/Pnt.java
@@ -120,9 +120,9 @@ public int hashCode() {
/* Pnts as vectors */
/**
- * DOCUMENT ME!
+ * Returns the Coordinate for the specified Dimension.
*
- * @param i DOCUMENT ME!
+ * @param i given dimension
*
* @return the specified coordinate of this Pnt
*/
@@ -131,7 +131,7 @@ public double coord(final int i) {
}
/**
- * DOCUMENT ME!
+ * Returns the Amount of Dimensions, in which the point is.
*
* @return this Pnt's dimension.
*/
diff --git a/src/main/java/de/cismet/math/delaunytriangulation/Simplex.java b/src/main/java/de/cismet/math/delaunytriangulation/Simplex.java
index 5524b91..2c8820e 100644
--- a/src/main/java/de/cismet/math/delaunytriangulation/Simplex.java
+++ b/src/main/java/de/cismet/math/delaunytriangulation/Simplex.java
@@ -141,8 +141,8 @@ public List> facets() {
* Report the boundary of a Set of Simplices. The boundary is a Set of facets where each facet is a Set of vertices
* .
*
- * @param DOCUMENT ME!
- * @param simplexSet DOCUMENT ME!
+ * @param vertices (generic type V)
+ * @param simplexSet Set of Simplices
*
* @return an Iterator for the facets that make up the boundary
*/
@@ -163,7 +163,7 @@ public static Set> boundary(final Set extends Simplex> simplexSe
/* Remaining methods are those required by AbstractSet */
/**
- * DOCUMENT ME!
+ * Returns the Iterator for Simplex's vertices.
*
* @return Iterator for Simplex's vertices.
*/
@@ -173,7 +173,7 @@ public Iterator iterator() {
}
/**
- * DOCUMENT ME!
+ * Returns the size (# of vertices) of this Simplex.
*
* @return the size (# of vertices) of this Simplex
*/
@@ -183,7 +183,7 @@ public int size() {
}
/**
- * DOCUMENT ME!
+ * Returns the hashCode of this Simplex.
*
* @return the hashCode of this Simplex
*/
@@ -193,9 +193,10 @@ public int hashCode() {
}
/**
- * We want to allow for different simplices that share the same vertex set.
+ * Tests, whether the Simplices are equal or not We want to allow for different simplices that share the same vertex
+ * set.
*
- * @param o DOCUMENT ME!
+ * @param o specified Simplix, which is compared to this Simplix
*
* @return true for equal Simplices
*/
diff --git a/src/main/java/de/cismet/math/delaunytriangulation/Triangulation.java b/src/main/java/de/cismet/math/delaunytriangulation/Triangulation.java
index 907d0a3..9b89aeb 100644
--- a/src/main/java/de/cismet/math/delaunytriangulation/Triangulation.java
+++ b/src/main/java/de/cismet/math/delaunytriangulation/Triangulation.java
@@ -81,7 +81,7 @@ public int size() {
}
/**
- * True iff the simplex is in this Triangulation.
+ * True if the simplex is in this Triangulation.
*
* @param simplex the simplex to check
*
diff --git a/src/main/java/de/cismet/netutil/Proxy.java b/src/main/java/de/cismet/netutil/Proxy.java
index b1ad74f..869972d 100644
--- a/src/main/java/de/cismet/netutil/Proxy.java
+++ b/src/main/java/de/cismet/netutil/Proxy.java
@@ -62,7 +62,7 @@ public Proxy() {
}
/**
- * Creates a new Proxy object.
+ * Creates a new Proxy object with specified host
and port
.
*
* @param host proxyURL
* @param port computerName
@@ -72,7 +72,8 @@ public Proxy(final String host, final int port) {
}
/**
- * Creates a new Proxy object.
+ * Creates a new Proxy object with specified host
, port
, username
and
+ * password
.
*
* @param host proxyURL
* @param port computerName
@@ -84,7 +85,8 @@ public Proxy(final String host, final int port, final String username, final Str
}
/**
- * Creates a new Proxy object.
+ * Creates a new Proxy object host
, port
, username
, password
and
+ * domain
. Additional it can be specified whether the Proxy is enabled or not
*
* @param host proxyURL
* @param port computerName
@@ -146,7 +148,7 @@ public void setPort(final int port) {
}
/**
- * Return as String.
+ * Return the Proxy's Attributes as String.
*
* @return "Proxy: " + host
+ ":" + port
+ " | username: " + username
+" |
* password: " + ((password
== null
) ? null
: "") + " |
@@ -344,11 +346,10 @@ public static Proxy fromSystem() {
}
/**
- * main.
+ * main program; used for testing. // NOTE: use cli library if there shall be more (complex) options
*
* @param args args
*/
- // NOTE: use cli library if there shall be more (complex) options
@SuppressWarnings("CallToThreadDumpStack")
public static void main(final String[] args) {
try {
diff --git a/src/main/java/de/cismet/tools/Base64.java b/src/main/java/de/cismet/tools/Base64.java
index 4fb972c..335f5b5 100644
--- a/src/main/java/de/cismet/tools/Base64.java
+++ b/src/main/java/de/cismet/tools/Base64.java
@@ -57,7 +57,7 @@ private Base64() {
*
* @return the base64 encoded input array
*
- * @throws IllegalArgumentException if the given array is of length null
+ * @throws IllegalArgumentException if the given array has length null
*/
public static byte[] toBase64(final byte[] byteString, final boolean wipeInput) {
if (byteString == null) {
diff --git a/src/main/java/de/cismet/tools/BrowserLauncher.java b/src/main/java/de/cismet/tools/BrowserLauncher.java
index bd9f7a1..5482a74 100644
--- a/src/main/java/de/cismet/tools/BrowserLauncher.java
+++ b/src/main/java/de/cismet/tools/BrowserLauncher.java
@@ -460,10 +460,10 @@ private static Object locateBrowser() {
}
/**
- * Attempts to open the default web browser to the gieven URL. In the second attempt he tries to open the url as a
+ * Attempts to open the default web browser to the given URL. In the second attempt he tries to open the url as a
* file.
*
- * @param url DOCUMENT ME!
+ * @param url url
*/
public static void openURLorFile(final String url) {
if (url == null) {
@@ -485,7 +485,7 @@ public static void openURLorFile(final String url) {
}
/**
- * Attempts to open the default web browser to the given URL.
+ * Attempts to open the given URL with the default web browser.
*
* @param url The URL to open
*
@@ -631,34 +631,37 @@ public static void openURL(final String url) throws Exception {
/**
* Methods required for Mac OS X. The presence of native methods does not cause any problems on other platforms.
+ * //Placeholder
*
- * @param instance DOCUMENT ME!
- * @param signature DOCUMENT ME!
+ * @param instance instance
+ * @param signature signature
*
- * @return DOCUMENT ME!
+ * @return int
*/
private static native int ICStart(int[] instance, int signature);
/**
- * DOCUMENT ME!
+ * Methods required for Mac OS X. The presence of native methods does not cause any problems on other platforms.
+ * //Placeholder
*
- * @param instance DOCUMENT ME!
+ * @param instance instance
*
- * @return DOCUMENT ME!
+ * @return int
*/
private static native int ICStop(int[] instance);
/**
- * DOCUMENT ME!
+ * Methods required for Mac OS X. The presence of native methods does not cause any problems on other platforms.
+ * //Placeholder
*
- * @param instance DOCUMENT ME!
- * @param hint DOCUMENT ME!
- * @param data DOCUMENT ME!
- * @param len DOCUMENT ME!
- * @param selectionStart DOCUMENT ME!
- * @param selectionEnd DOCUMENT ME!
+ * @param instance intance
+ * @param hint hint
+ * @param data data
+ * @param len len
+ * @param selectionStart selectionStart
+ * @param selectionEnd selectiomEnd
*
- * @return DOCUMENT ME!
+ * @return int
*/
private static native int ICLaunchURL(int instance,
byte[] hint,
diff --git a/src/main/java/de/cismet/tools/CalculationCache.java b/src/main/java/de/cismet/tools/CalculationCache.java
index f6eb565..9bf69a6 100644
--- a/src/main/java/de/cismet/tools/CalculationCache.java
+++ b/src/main/java/de/cismet/tools/CalculationCache.java
@@ -118,7 +118,7 @@ public void run() {
}
/**
- * Get the time in milliseconds, the result should be cached.
+ * Gets the time in milliseconds, the result should be cached.
*
* @return the time in milliseconds
*/
@@ -127,7 +127,7 @@ public long getTimeToCacheResults() {
}
/**
- * set the time in milliseconds, the result should be cached.
+ * Sets the time in milliseconds, the result should be cached.
*
* @param timeToCacheResults the timeToCacheResults to set
*/
@@ -136,7 +136,7 @@ public void setTimeToCacheResults(final long timeToCacheResults) {
}
/**
- * get the time in milliseconds, exceptions, which were thrown during the calculation of a value, should be cached.
+ * Gets the time in milliseconds, exceptions, which were thrown during the calculation of a value, should be cached.
*
* @return the time in milliseconds
*/
@@ -145,7 +145,7 @@ public long getTimeToCacheExceptions() {
}
/**
- * set the time in milliseconds, exceptions, which were thrown during the calculation of a value, should be cached.
+ * Sets the time in milliseconds, exceptions, which were thrown during the calculation of a value, should be cached.
*
* @param timeToCacheExceptions the timeToCacheException to set
*/
diff --git a/src/main/java/de/cismet/tools/Calculator.java b/src/main/java/de/cismet/tools/Calculator.java
index 419f813..45ac87a 100644
--- a/src/main/java/de/cismet/tools/Calculator.java
+++ b/src/main/java/de/cismet/tools/Calculator.java
@@ -8,7 +8,7 @@
package de.cismet.tools;
/**
- * Calculator.
+ * Interface Calculator.
*
* @author therter
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/CurrentStackTrace.java b/src/main/java/de/cismet/tools/CurrentStackTrace.java
index ac4a49c..b4af662 100644
--- a/src/main/java/de/cismet/tools/CurrentStackTrace.java
+++ b/src/main/java/de/cismet/tools/CurrentStackTrace.java
@@ -12,7 +12,7 @@
package de.cismet.tools;
/**
- * CurrentStackTrace.
+ * Class for the Stack Trace of the currently executing thread.
*
* @author thorsten
* @version $Revision$, $Date$
@@ -21,6 +21,11 @@ public class CurrentStackTrace extends Throwable {
//~ Methods ----------------------------------------------------------------
+ /**
+ * Returns an array of stack trace elements representing the stack dump of currently executing thread.
+ *
+ * @return array of stack trace elements
+ */
@Override
public StackTraceElement[] getStackTrace() {
return Thread.currentThread().getStackTrace();
diff --git a/src/main/java/de/cismet/tools/DebugSwitches.java b/src/main/java/de/cismet/tools/DebugSwitches.java
index 7f81cb5..fd0fc65 100644
--- a/src/main/java/de/cismet/tools/DebugSwitches.java
+++ b/src/main/java/de/cismet/tools/DebugSwitches.java
@@ -40,7 +40,7 @@ private DebugSwitches() {
/**
* Getter for Instance.
*
- * @return instance
+ * @return {@link #instance}
*/
public static DebugSwitches getInstance() {
if (instance == null) {
diff --git a/src/main/java/de/cismet/tools/FileUtils.java b/src/main/java/de/cismet/tools/FileUtils.java
index ddad282..7ab2837 100644
--- a/src/main/java/de/cismet/tools/FileUtils.java
+++ b/src/main/java/de/cismet/tools/FileUtils.java
@@ -259,7 +259,7 @@ public static void copyFile(final File inFile, final File outFile) throws FileNo
/**
* Copies the Content of the specified Directory
. It uses {@link FilesFilter}. If it is a
- * File
, it copies the File and if it is a Directory
, the methode start recursive again with the
+ * File
, it copies the File and if it is a Directory
, the method start recursive again with the
* found Directory
*
* @param srcDir Source Directory
diff --git a/src/main/java/de/cismet/tools/LinkedProperties.java b/src/main/java/de/cismet/tools/LinkedProperties.java
index 2097244..7389f93 100644
--- a/src/main/java/de/cismet/tools/LinkedProperties.java
+++ b/src/main/java/de/cismet/tools/LinkedProperties.java
@@ -13,6 +13,7 @@
import java.util.Collection;
import java.util.Enumeration;
+import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map;
@@ -20,7 +21,7 @@
import java.util.Set;
/**
- * Linked Properties.
+ * Creates {@link LinkedHashMap} for Properties.
*
* @author thorsten
* @version $Revision$, $Date$
@@ -34,14 +35,17 @@ public class LinkedProperties extends Properties {
//~ Methods ----------------------------------------------------------------
/**
- * Associates a given value
with a given key.
+ * Associates a given value
with a given key
. Removes the previous associated
+ * value
, if there is any.
*
- * @param key DOCUMENT ME!
- * @param value DOCUMENT ME!
+ * @param key The key for the given value
+ * @param value The value for the given key
*
- * @return the previous value
associated with key
, or null
if there was no
+ * @return The previous value
associated with key
, or null
if there was no
* mapping for key
. (A null
return can also indicate that the map previously
* associated null
with key
.)
+ *
+ * @see HashMap#put(java.lang.Object, java.lang.Object)
*/
@Override
@@ -52,9 +56,11 @@ public synchronized Object put(final Object key, final Object value) {
/**
* Returns the value
for the given key.
*
- * @param key DOCUMENT ME!
+ * @param key The key, whose value is searched
*
* @return the associated value
. Returns null
, if the is no mapping for this key.
+ *
+ * @see HashMap#get(java.lang.Object)
*/
@Override
public synchronized Object get(final Object key) {
@@ -62,7 +68,9 @@ public synchronized Object get(final Object key) {
}
/**
- * Removes every mapping
of this map.
+ * Clears the map
. (Removes every mapping
for this map
)
+ *
+ * @see HashMap#clear()
*/
@Override
@@ -71,11 +79,11 @@ public synchronized void clear() {
}
/**
- * DOCUMENT ME!
+ * Not Supported.
*
- * @return DOCUMENT ME!
+ * @return error
*
- * @throws UnsupportedOperationException DOCUMENT ME!
+ * @throws UnsupportedOperationException not supported
*/
@Override
public synchronized Object clone() {
@@ -83,11 +91,13 @@ public synchronized Object clone() {
}
/**
- * Tests whether there is any mapping
with this value
or not.
+ * Tests whether there is any key
associated with this value
or not.
*
- * @param value value whose presence in this map is to be tested
+ * @param value searched value
*
* @return True, if there is a key
with this value
+ *
+ * @see HashMap#containsValue(java.lang.Object)
*/
@Override
public boolean containsValue(final Object value) {
@@ -95,11 +105,13 @@ public boolean containsValue(final Object value) {
}
/**
- * Tests whether there is any mapping
with this value
or not.
+ * Tests whether there is any key
associated with this value
or not.
*
- * @param value value whose presence in this map is to be tested
+ * @param value searched value
*
* @return True, if there is a key
with this value
+ *
+ * @see HashMap#containsValue(java.lang.Object)
*/
@Override
@@ -110,9 +122,11 @@ public synchronized boolean contains(final Object value) {
/**
* Tests whether the specified key is in the map or not.
*
- * @param key key whose presence in this map is to be tested
+ * @param key searched key
+ *
+ * @return True, if there is this key
*
- * @return True, if there is a key
+ * @see HashMap#containsKey(java.lang.Object)
*/
@Override
@@ -121,9 +135,11 @@ public synchronized boolean containsKey(final Object key) {
}
/**
- * Returns all values
. Uses an Iterator
over all elements
.
+ * Returns all values
as Enumeration. Uses an Iterator
over all elements
.
*
- * @return every value
in this map
+ * @return every value
in this map as Enumeration
+ *
+ * @see IteratorEnumeration
*/
@Override
public synchronized Enumeration elements() {
@@ -134,6 +150,8 @@ public synchronized Enumeration elements() {
* Returns a Set
view of the mappings contained in this map.
*
* @return Set
+ *
+ * @see HashMap#entrySet()
*/
@Override
public Set entrySet() {
@@ -141,13 +159,13 @@ public Set entrySet() {
}
/**
- * DOCUMENT ME!
+ * Not Supported.
*
- * @param o DOCUMENT ME!
+ * @param o Object
*
- * @return DOCUMENT ME!
+ * @return error
*
- * @throws UnsupportedOperationException DOCUMENT ME!
+ * @throws UnsupportedOperationException not supported
*/
@Override
@@ -159,6 +177,8 @@ public synchronized boolean equals(final Object o) {
* Tests whether there is any mapping on the map or not.
*
* @return true, if there is no mapping
+ *
+ * @see HashMap#isEmpty()
*/
@Override
public synchronized boolean isEmpty() {
@@ -166,9 +186,11 @@ public synchronized boolean isEmpty() {
}
/**
- * Returns all keys
. Uses an Iterator
over all elements
.
+ * Returns all keys
as Enumeration. Uses an Iterator
over all elements
.
+ *
+ * @return every key
in this map as Enumeration.
*
- * @return every key
in this map
+ * @see IteratorEnumeration
*/
@Override
public synchronized Enumeration keys() {
@@ -179,6 +201,8 @@ public synchronized Enumeration keys() {
* Returns a Set
view of the keys contained in this map.
*
* @return Set
+ *
+ * @see HashMap#keySet()
*/
@Override
public Set keySet() {
@@ -186,11 +210,11 @@ public Set keySet() {
}
/**
- * DOCUMENT ME!
+ * not supported.
*
- * @return DOCUMENT ME!
+ * @return error
*
- * @throws UnsupportedOperationException DOCUMENT ME!
+ * @throws UnsupportedOperationException not supported
*/
@Override
public Enumeration propertyNames() {
@@ -199,10 +223,12 @@ public Enumeration propertyNames() {
/**
* Copies all of the mappings
from the specified map
to this map
. These
- * mappings
will replace any mappings
that this map
had for any of the
- * keys
currently in the specified map
+ * mappings
will replace any mappings
, that this map
had for any of the
+ * keys
currently in the specified map
*
* @param t map
+ *
+ * @see HashMap#putAll(java.util.Map)
*/
@Override
public synchronized void putAll(final Map t) {
@@ -216,6 +242,8 @@ public synchronized void putAll(final Map t) {
*
* @return the previous value
associated with key
, or null
if there was no
* mapping for key
.
+ *
+ * @see HashMap#remove(java.lang.Object)
*/
@Override
public synchronized Object remove(final Object key) {
@@ -223,9 +251,11 @@ public synchronized Object remove(final Object key) {
}
/**
- * Returns the number of key-value mappings in this map.
+ * Returns the amount of mappings in this map.
+ *
+ * @return the amount of mappings in this map
*
- * @return the number of key-value mappings in this map
+ * @see HashMap#size()
*/
@Override
public synchronized int size() {
@@ -233,11 +263,11 @@ public synchronized int size() {
}
/**
- * DOCUMENT ME!
+ * not supported.
*
- * @return DOCUMENT ME!
+ * @return error
*
- * @throws UnsupportedOperationException DOCUMENT ME!
+ * @throws UnsupportedOperationException not supported!
*/
@Override
public Collection values() {
@@ -294,6 +324,8 @@ public IteratorEnumeration(final Iterator i) {
* Tests whether the Iterator
as more Elemtents or not.
*
* @return True
, if the Iterator
has more Elements.
+ *
+ * @see Iterator#hasNext()
*/
@Override
public boolean hasMoreElements() {
@@ -304,6 +336,8 @@ public boolean hasMoreElements() {
* Returns the next element in the iteration.
*
* @return the next element in the iteration
+ *
+ * @see Iterator#next()
*/
@Override
public Object nextElement() {
diff --git a/src/main/java/de/cismet/tools/PasswordEncrypter.java b/src/main/java/de/cismet/tools/PasswordEncrypter.java
index 82395e8..3537b73 100644
--- a/src/main/java/de/cismet/tools/PasswordEncrypter.java
+++ b/src/main/java/de/cismet/tools/PasswordEncrypter.java
@@ -299,7 +299,7 @@ private void cmdGoActionPerformed(final java.awt.event.ActionEvent evt) {
} //GEN-LAST:event_cmdGoActionPerformed
/**
- * main.
+ * main program.
*
* @param args the command line arguments
*
diff --git a/src/main/java/de/cismet/tools/ScriptRunner.java b/src/main/java/de/cismet/tools/ScriptRunner.java
index d741997..e5c5c82 100644
--- a/src/main/java/de/cismet/tools/ScriptRunner.java
+++ b/src/main/java/de/cismet/tools/ScriptRunner.java
@@ -321,6 +321,8 @@ private String getDelimiter() {
* >>>>>>> .r4704
*
* @param o Object
which is going to be printed
+ *
+ * @see PrintWriter#print(java.lang.Object)
*/
private void print(final Object o) {
if (logWriter != null) {
@@ -332,6 +334,9 @@ private void print(final Object o) {
* If logWriter is Empty print the Object in logWriter.Does a Line Break and flushes.
*
* @param o Object
which is going to be printed
+ *
+ * @see PrintWriter#println(java.lang.Object)
+ * @see PrintWriter#flush()
*/
private void println(final Object o) {
if (logWriter != null) {
@@ -344,6 +349,9 @@ private void println(final Object o) {
* If errorLogWriter is Empty print the Object in errorLogWriter.Does a Line Break and flushes.
*
* @param o Object
which is going to be printed
+ *
+ * @see PrintWriter#println(java.lang.Object)
+ * @see PrintWriter#flush()
*/
private void printlnError(final Object o) {
if (errorLogWriter != null) {
@@ -354,6 +362,8 @@ private void printlnError(final Object o) {
/**
* Flushes the Streams.
+ *
+ * @see PrintWriter#flush()
*/
private void flush() {
if (logWriter != null) {
diff --git a/src/main/java/de/cismet/tools/Sorter.java b/src/main/java/de/cismet/tools/Sorter.java
index 4a42d6a..466312d 100644
--- a/src/main/java/de/cismet/tools/Sorter.java
+++ b/src/main/java/de/cismet/tools/Sorter.java
@@ -17,7 +17,8 @@ public class Sorter {
// -----------------------------------------------------------------------------------------------
/**
- * Tests whether the specified Array
is sorted or not.
+ * Tests whether the specified Array
is sorted or not. Sorted Arrays
are
+ * Arrays
with only ONE Element.
*
* @param array Array
, which is going to be tested.
*
@@ -167,7 +168,7 @@ private static int partitionIt(final Comparable[] array, final int left, final i
//----------------------------------------------------------------------------------------------
/**
- * swaps two Elements of the specified Array.
+ * Swaps two Elements of the specified Array.
*
* @param array Array
, which is going to get sorted
* @param i Location of Element one
diff --git a/src/main/java/de/cismet/tools/StaticDebuggingTools.java b/src/main/java/de/cismet/tools/StaticDebuggingTools.java
index f431f05..222f171 100644
--- a/src/main/java/de/cismet/tools/StaticDebuggingTools.java
+++ b/src/main/java/de/cismet/tools/StaticDebuggingTools.java
@@ -18,7 +18,7 @@
import java.io.File;
/**
- * StaticDebuggingTools.
+ * Tests whether the File exists in the User's Home Directory or not.
*
* @author cschmidt
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/StaticHtmlTools.java b/src/main/java/de/cismet/tools/StaticHtmlTools.java
index 4b50e79..4ff2b51 100644
--- a/src/main/java/de/cismet/tools/StaticHtmlTools.java
+++ b/src/main/java/de/cismet/tools/StaticHtmlTools.java
@@ -122,7 +122,7 @@ public static String stripMetaTag(final String text) {
}
/**
- * main.
+ * main program.
*
* @param args args
*/
diff --git a/src/main/java/de/cismet/tools/StaticXMLTools.java b/src/main/java/de/cismet/tools/StaticXMLTools.java
index 3317f37..96dfd50 100644
--- a/src/main/java/de/cismet/tools/StaticXMLTools.java
+++ b/src/main/java/de/cismet/tools/StaticXMLTools.java
@@ -17,7 +17,7 @@
import java.awt.Font;
/**
- * Static XML Tools.
+ * Converter for Color to XML and XML to Color.
*
* @author thorsten
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/StringTools.java b/src/main/java/de/cismet/tools/StringTools.java
index 87023ca..5ebb677 100644
--- a/src/main/java/de/cismet/tools/StringTools.java
+++ b/src/main/java/de/cismet/tools/StringTools.java
@@ -13,7 +13,7 @@
package de.cismet.tools;
/**
- * String Tools.
+ * Tool for deleting Whitespaces in Strings
.
*
* @author schlob
* @version $Revision$, $Date$
diff --git a/src/main/java/de/cismet/tools/TextFromFile.java b/src/main/java/de/cismet/tools/TextFromFile.java
index f50f7cc..bd19302 100644
--- a/src/main/java/de/cismet/tools/TextFromFile.java
+++ b/src/main/java/de/cismet/tools/TextFromFile.java
@@ -11,7 +11,7 @@
import java.util.*;
/**
- * Class for getting Text from File.
+ * Tool for extract Text from File.
*
* @version $Revision$, $Date$
*/
diff --git a/src/main/java/de/cismet/tools/TimeoutThread.java b/src/main/java/de/cismet/tools/TimeoutThread.java
index 9f168dc..a038884 100644
--- a/src/main/java/de/cismet/tools/TimeoutThread.java
+++ b/src/main/java/de/cismet/tools/TimeoutThread.java
@@ -47,8 +47,8 @@ public TimeoutThread() {
*
* @return result
*
- * @throws Exception DOCUMENT ME!
- * @throws TimeoutException DOCUMENT ME!
+ * @throws Exception an exception during the execution of the thread ocured
+ * @throws TimeoutException Execution is timeouted and interrupted.
*/
public T start(final long timeInMillis) throws Exception {
final Thread t = new Thread(this);
diff --git a/src/main/java/de/cismet/tools/URLSplitter.java b/src/main/java/de/cismet/tools/URLSplitter.java
index 29e3bcd..6f8ccb4 100644
--- a/src/main/java/de/cismet/tools/URLSplitter.java
+++ b/src/main/java/de/cismet/tools/URLSplitter.java
@@ -8,7 +8,14 @@
package de.cismet.tools;
/**
- * Urlsplitter.
+ * Tool, that detects the following informations in a String
url and saves them into single Strings.
+ *
+ *
+ * - prot_prefix
+ * - server
+ * - path
+ * - object_name
+ *
*
* @author thorsten.hell@cismet.de
* @version $Revision$, $Date$
@@ -25,7 +32,8 @@ public class URLSplitter {
//~ Constructors -----------------------------------------------------------
/**
- * Creates a new URLSplitter object.
+ * Creates a new URLSplitter object from the url, detects the prot_prefix, server, path and object_name and saves
+ * these informations into new Strings.
*
* @param url given url
*/
@@ -139,7 +147,7 @@ public String toString() {
}
/**
- * main.
+ * main program. For testing.
*
* @param args args
*/
diff --git a/src/main/java/de/cismet/tools/configuration/ConfigAttrProvider.java b/src/main/java/de/cismet/tools/configuration/ConfigAttrProvider.java
index e3183f6..6f01d30 100644
--- a/src/main/java/de/cismet/tools/configuration/ConfigAttrProvider.java
+++ b/src/main/java/de/cismet/tools/configuration/ConfigAttrProvider.java
@@ -18,29 +18,29 @@ public interface ConfigAttrProvider {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * Getter for the UserConfig value with specified key.
*
- * @param key DOCUMENT ME!
+ * @param key key, which value is searched
*
- * @return DOCUMENT ME!
+ * @return value as String
*/
String getUserConfigAttr(final String key);
/**
- * DOCUMENT ME!
+ * Getter for the GroupConfig value with specified key.
*
- * @param key DOCUMENT ME!
+ * @param key key, which value is searched
*
- * @return DOCUMENT ME!
+ * @return value as String
*/
String getGroupConfigAttr(final String key);
/**
- * DOCUMENT ME!
+ * Getter for the DomainConfig value with specified key.
*
- * @param key DOCUMENT ME!
+ * @param key key, which value is searched
*
- * @return DOCUMENT ME!
+ * @return value as String
*/
String getDomainConfigAttr(final String key);
}
diff --git a/src/main/java/de/cismet/tools/configuration/Configurable.java b/src/main/java/de/cismet/tools/configuration/Configurable.java
index 4c3aef9..6fc2914 100644
--- a/src/main/java/de/cismet/tools/configuration/Configurable.java
+++ b/src/main/java/de/cismet/tools/configuration/Configurable.java
@@ -20,9 +20,9 @@ public interface Configurable {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * DOCUMENT ME! Always used after masterConfigure
*
- * @param parent DOCUMENT ME!
+ * @param parent configuration.xml
*/
void configure(Element parent);
/**
diff --git a/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java b/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java
index c15d106..5c1825d 100644
--- a/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java
+++ b/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java
@@ -686,90 +686,90 @@ public void writeConfiguration(final String path) {
}
/**
- * DOCUMENT ME!
+ * Getter for {@link #defaultFileName}.
*
- * @return DOCUMENT ME!
+ * @return defaultFileName
*/
public String getDefaultFileName() {
return defaultFileName;
}
/**
- * DOCUMENT ME!
+ * Setter for {@link #defaultFileName}.
*
- * @param defaultFileName DOCUMENT ME!
+ * @param defaultFileName defaultFileName
*/
public void setDefaultFileName(final String defaultFileName) {
this.defaultFileName = defaultFileName;
}
/**
- * DOCUMENT ME!
+ * Getter for {@link #classPathFolder}.
*
- * @return DOCUMENT ME!
+ * @return classPathFolder
*/
public String getClassPathFolder() {
return classPathFolder;
}
/**
- * DOCUMENT ME!
+ * Setter for {@link #classPathFolder}.
*
- * @param classPathFolder DOCUMENT ME!
+ * @param classPathFolder classPathFolder
*/
public void setClassPathFolder(final String classPathFolder) {
this.classPathFolder = classPathFolder;
}
/**
- * DOCUMENT ME!
+ * Getter for {@link #home}.
*
- * @return DOCUMENT ME!
+ * @return home
*/
public String getHome() {
return home;
}
/**
- * DOCUMENT ME!
+ * Setter for {@link #home}.
*
- * @param home DOCUMENT ME!
+ * @param home home
*/
public void setHome(final String home) {
this.home = home;
}
/**
- * DOCUMENT ME!
+ * Getter for {@link #fs}.
*
- * @return DOCUMENT ME!
+ * @return file separator
*/
public String getFileSeperator() {
return fs;
}
/**
- * DOCUMENT ME!
+ * Setter for {@link #fs}.
*
- * @param fs DOCUMENT ME!
+ * @param fs file seperator
*/
public void setFileSeperator(final String fs) {
this.fs = fs;
}
/**
- * DOCUMENT ME!
+ * Getter for {@link #fallBackFileName}.
*
- * @return DOCUMENT ME!
+ * @return fallBackFileName
*/
public String getFallBackFileName() {
return fallBackFileName;
}
/**
- * DOCUMENT ME!
+ * Setter for {@link #fallBackFileName}.
*
- * @param fallBackFileName DOCUMENT ME!
+ * @param fallBackFileName fallBackFileName
*/
public void setFallBackFileName(final String fallBackFileName) {
this.fallBackFileName = fallBackFileName;
@@ -778,7 +778,7 @@ public void setFallBackFileName(final String fallBackFileName) {
//~ Inner Interfaces -------------------------------------------------------
/**
- * DOCUMENT ME!
+ * AttrResolver Interface.
*
* @version $Revision$, $Date$
*/
@@ -787,9 +787,9 @@ private static interface AttrResolver {
//~ Methods ------------------------------------------------------------
/**
- * DOCUMENT ME!
+ * Getter for Attribute.
*
- * @return DOCUMENT ME!
+ * @return Attribute
*/
String getAttr();
}
From 1114bc1e52f67966fa0b349a84d9f8b6d8ab8d9b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Thu, 10 Jan 2013 18:54:47 +0100
Subject: [PATCH 24/34] #9 Java doc Improvements of package
de.cismet.tools.configuration
---
.../tools/configuration/Configurable.java | 12 +++----
.../configuration/ConfigurationManager.java | 35 +++++++++++++++----
2 files changed, 35 insertions(+), 12 deletions(-)
diff --git a/src/main/java/de/cismet/tools/configuration/Configurable.java b/src/main/java/de/cismet/tools/configuration/Configurable.java
index 6fc2914..b697435 100644
--- a/src/main/java/de/cismet/tools/configuration/Configurable.java
+++ b/src/main/java/de/cismet/tools/configuration/Configurable.java
@@ -20,21 +20,21 @@ public interface Configurable {
//~ Methods ----------------------------------------------------------------
/**
- * DOCUMENT ME! Always used after masterConfigure
+ * Configures the Local .conf Always used after masterConfigure.
*
- * @param parent configuration.xml
+ * @param parent JDOM root
*/
void configure(Element parent);
/**
- * DOCUMENT ME!
+ * Configures the Server .conf.
*
- * @param parent DOCUMENT ME!
+ * @param parent JDOM root
*/
void masterConfigure(Element parent);
/**
- * DOCUMENT ME!
+ * Gets the JDOM Root for this Configurable.
*
- * @return DOCUMENT ME!
+ * @return xml-Configuration
*
* @throws NoWriteError DOCUMENT ME!
*/
diff --git a/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java b/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java
index 5c1825d..c8252c7 100644
--- a/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java
+++ b/src/main/java/de/cismet/tools/configuration/ConfigurationManager.java
@@ -315,7 +315,7 @@ private Element getRootObjectFromClassPath() {
}
/**
- * Gets the object from specified ClassPath.
+ * Loads the object from specified ClassPath.
*
* @param classPathUrl Classpath as Url
*
@@ -629,7 +629,10 @@ private AttrResolver getAttrResolver(final AttrResolver resolver, final String k
}
/**
- * DOCUMENT ME!
+ * Writes a new Configuration File into the LocalAbsouluteConfigurationFolder.
+ *
+ * @see #getLocalAbsoluteConfigurationFolder()
+ * @see #writeConfiguration(java.lang.String)
*/
public void writeConfiguration() {
new File(getLocalAbsoluteConfigurationFolder()).mkdirs();
@@ -637,18 +640,18 @@ public void writeConfiguration() {
}
/**
- * DOCUMENT ME!
+ * Returns the Url "~/.cismet/"
*
- * @return DOCUMENT ME!
+ * @return ~/.cismet/
*/
public String getLocalAbsoluteConfigurationFolder() {
return home + fs + folder + fs;
}
/**
- * DOCUMENT ME!
+ * Writes a Configuration File in specified path.
*
- * @param path DOCUMENT ME!
+ * @param path path
*/
public void writeConfiguration(final String path) {
try {
@@ -864,6 +867,11 @@ public EntryResolver(final ConfigAttrProvider provider) {
//~ Methods ------------------------------------------------------------
+ /**
+ * DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ */
@Override
public String getAttr() {
return null;
@@ -891,6 +899,11 @@ public UserAttrResolver(final String key, final ConfigAttrProvider provider) {
//~ Methods ------------------------------------------------------------
+ /**
+ * DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ */
@Override
public String getAttr() {
return provider.getUserConfigAttr(key);
@@ -918,6 +931,11 @@ public GroupAttrResolver(final String key, final ConfigAttrProvider provider) {
//~ Methods ------------------------------------------------------------
+ /**
+ * DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ */
@Override
public String getAttr() {
return provider.getGroupConfigAttr(key);
@@ -945,6 +963,11 @@ public DomainAttrResolver(final String key, final ConfigAttrProvider provider) {
//~ Methods ------------------------------------------------------------
+ /**
+ * DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ */
@Override
public String getAttr() {
return provider.getDomainConfigAttr(key);
From ee5e71c86d79847dfd48dc05c0bb07d7273fd875 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20M=C3=BCsel?=
Date: Wed, 16 Jan 2013 18:45:02 +0100
Subject: [PATCH 25/34] #9 Improved pom.xml for modified Doclet + added
resources and stylesheet.css
---
nb-configuration.xml | 18 +
pom.xml | 13 +
.../resources/cismet_signet_rgb_buntesC.png | Bin 0 -> 4553 bytes
src/main/javadoc/resources/dark_paper.png | Bin 0 -> 932 bytes
src/main/javadoc/resources/logo16.png | Bin 0 -> 359 bytes
src/main/javadoc/resources/noise_modified.png | Bin 0 -> 961 bytes
src/main/javadoc/resources/paper.png | Bin 0 -> 146347 bytes
src/main/javadoc/stylesheet.css | 484 ++++++++++++++++++
8 files changed, 515 insertions(+)
create mode 100644 nb-configuration.xml
create mode 100644 src/main/javadoc/resources/cismet_signet_rgb_buntesC.png
create mode 100644 src/main/javadoc/resources/dark_paper.png
create mode 100644 src/main/javadoc/resources/logo16.png
create mode 100644 src/main/javadoc/resources/noise_modified.png
create mode 100644 src/main/javadoc/resources/paper.png
create mode 100644 src/main/javadoc/stylesheet.css
diff --git a/nb-configuration.xml b/nb-configuration.xml
new file mode 100644
index 0000000..ec4540c
--- /dev/null
+++ b/nb-configuration.xml
@@ -0,0 +1,18 @@
+
+
+
+
+
+ none
+
+
diff --git a/pom.xml b/pom.xml
index b48b8bc..a2adaaa 100644
--- a/pom.xml
+++ b/pom.xml
@@ -154,6 +154,19 @@
maven-surefire-plugin
2.9
+
+ org.apache.maven.plugins
+ maven-javadoc-plugin
+ 2.9
+
+ false
+ Doclet.ListClass
+ C:\Users\tmuesel\Gitwork\JavaDoc\dist\JavaDoc.jar
+ true
+ ${basedir}/src/main/javadoc
+ ${basedir}/src/main/javadoc/stylesheet.css
+
+
cismetCommons
diff --git a/src/main/javadoc/resources/cismet_signet_rgb_buntesC.png b/src/main/javadoc/resources/cismet_signet_rgb_buntesC.png
new file mode 100644
index 0000000000000000000000000000000000000000..e5a854be3e0c0fe84a41331fc853984b10b4cfd7
GIT binary patch
literal 4553
zcmV;)5jO6LP)~)z@LwUrzF=ne
zCy`S~a&t~jPEIq(4OdQ1PTP?iuAH2lwj(!OIXO9PM{c-sa&p>^+;HXO#1nVu?Cc!e+vkNs
zVeRFYU*7BeNeEv4t$`uHfE1_xlbQV`#rcr53-HC@`ZTcFIz!$8UIP9A%m(I~*{Ybb
zh5+M%3BX8TD`3NJLpp&f@GvkRm~UoJ#F3RIlD5X_JFMF^6nG1Gq1*K$@Q9hM%|HjA
zl%L~)$CAj&dc}1p@DJ<$&swGQEU+NB?kbk6?_{h;A|!PHdjJOj`vW6zM$2cby&PxU
zdgFpZp>Rlo`$LhmC2$C^9q>tDo8aG}q-(IcI1cz_8WTx6444e;6f$%Wuzhfi2i8hj
z2uwD!-+9W~A2=Nt4Qx_yfP;6H$4V#)&84Y)H
zxKrUqPy~JH-*pmhwG)STfzyDC&8*iKMAF{4V9Vhi
zbFKtN_y)xWtI)@Av36msz{Q`ObM$o!IpHZBeU~
z2H=j7&%p1Omo;N?Te_bnok-HrL^oPb0n>o1%`DA;*$(Qzv_3EN!5(8)0;9|<&Xyrd
zzKq|`_#5Esy~Sd6VP@|ElO@du=HjB>qwpl~B{K`n?l7~(l0FB_!Udw%V>94OxUHKH
z7Zd*8bppQtPBXLDJm&?#%w7eKkaP{s=^y4xzD&~2X0|$toL*R)beX0*B!q*=vT
zQI~y;RyR4X;bOpio(r!Kl^}xuD375hnAta@8m;b_*?ipA`q_}7+u^qKEx~$*t5zwE
z0v-YOYrHz4Y)mwx(-Twhcg)@ie8$YK^Id{B37;>QC7EjxkzhNtm&ed4G4l?8g>z8*
za*vta8dZpyy@=m)d7!70zU(n(x|v<+F)kD{TY*a(3R?wzzg12dKVrCQmC{bYZTLG%
zo55FVl~UNUyhj3G(8->|ZvYMm9?Dk7=hU?oSBjsaeoi33bGWTcWCB0i=@D*;vqJ0Q
z0-WEl9vcy|C6lx*F2$@K3vt2PsS&JD!(!+*BD>(%NPK9xYL(IuT=3$M=BeY&sWI>S
z34S3U^MJ3K+50i&G@9ieW5#B#MRbOFjJZ2W6$3N71-I1yL1Jzz;bXYcD1qej`w8>$_~4^!ua!Q66VY#m+&|gOs*$vc##unU6X882?U12-
zFA4y)N@)*Vn18!4km$L16Yz_<`ChwZ$allXk5dE|O1f53-SCPA@;4r1o=!ndqYRgi
zt{d0+Y!vlltKPw#u4aary$mc08FoaLI{47F;yRo5iyV)-*PiGxX1Qjn8W*S$kNpBrpRv*!Ac&(o?(5t~A-QYz7!Cx~I}
zSF4n~%FP62cYS`wE0U?y9D=RGO%ZPS7|u`lh@@vFO_#Kvq__c_S@K2-b2Mtjl~mU-
z!*y-K`F)uU)bpXGm6;Hm4qO~fD?YGcbl~Eb{?B9VZiH_W-@=`!wkxOMPNSlp2#)~1
z7hJ1?I%K~E7Gzz=y@B`~Uigg3ntF!oePByT$2Lfp=jlB@aJZz+&8%sKKRfVqShp&}
z@H1RKPT&P8MFlqnGkZbOw{TJ1aoH5-zc>PTPtv_OBX(n(goPxbsd0LehEcyd$p*lG
zHb@;GcE!axHiZJ=q5iFm?v}4KoRf%ltD`os
znZk3!^;cdC=F;3@Il;`iSw432-s$aZ7Hf2p3g>OqG
zpVP-!J@{G`Gh1n9r{d~I{Wc>phXIdEnj)!Qd{Rz0x#5aHf%e`a`ReX-Vw9+NVXIZado&
zGg|~Kl5{eza_7;wPDW`xfWv@WB^?^4!a@#VoxkS+sZ@hViN~8MyaRZqnF=H%O~aL_
z&R4q-q%+L|W(9${6M}1hl6Sn>2)J3&US?(q=jv~S8Ll@2-(?PNt2nRON+cjn!`1Ij
z$;@npnO$jS<8a6EhvU*cl0<+H1g?>^Q5rh-Bf?7Jv{FIOrc=Px_DLhHqS36uKTX4@
z^5>qC`lO%B2Qz!q%x0O{kvJoEFs}1X*bCJYBWdsE9nBzY#pP4ww%<@FmaA*XIO9Ac
zZY!3nz6qyGa5dNKQJ_t`Kc|hEtu?a+W_AMZn|>dnN92D)QoAMYHW`_f#@y{^W2G`9c$Ah3+>)j#4
z+P2Gj+7tka1pT(?vKfR^vLjM8RjpuszZG*!3&S>>l8AzlfG#+)^x8qsAlMLHKqN;7mz7#n7o=5R?o)3%>;0PiCx6
zUn9(Ljc!z`RZxZEG+>FOnGyWIX~zln$cKijSgx+cIb?s|2*C;HBw|Nk_;9=UE03WY
z0=KtNmC%+W=y>F_g6$U}CTS70Mf+38uyeB3L(*2bbTM!?;yB-10RRLE*DAJ%?`(
zJS^$ZxbpfqBR$5%38m=o%p^QCV!EW=vk)%n0$^O7A=?5!kkngSxn+bW_DA)btw)b-
zkc#E%`^9qg9AI}`Nnqb(=B$}iELW4h3^VX=j=DK8Thi5%K9x{zpCKsme5A+FR;Vi4
zRs@+1(?f<01m;NkY?`tqO(Q)1?rq@c-rA!D`iHrjCML~mt=nU;Sgt-)ELRT$cEok+
zeVFD|io6N9H0dP4vGccx7XEPz@Pwo}k`9zKD5)OpO3=yp5?~jP;jQd)Xk{)T+@&!T
zSS%@Vzf4I3BwdVO2kleMY-z}tu>O(*fU6`O=%ru}__XVySgtMw{tcj3DGkPT`PdQ{
zVLh1M4d5}PQ}63e;HYA`no1K)GkZwVL|kl_Z<28VSD*h7V6CJFfCq4^idX6V#Bz1k
zNyn1L;8(gQE`x9CT-H(QB5z-hQIN1r~1o8f-vlO;U`+=a{0eHmDRTQTo|bNlRw>owu~
z%&!K%W@b_R%ReJp%e+WLU1>Cm4}dAanBbH%GtBHVTwSW%k(?eEn3+#vdrlq9tcG(<
zJQDHN9e|T?*)TJKIlx80cYuG!88Kg@wHz2@W|3O=nb~g$Z!8;|Ry16%0Aq{g>ZG)M
zT49*k?YOPh!bZsJ{6f=7Ve&Fub|_n%BU9m3b6l?>MkT!84O
zi{)y=`?Z
z@3IUH?G!e+K>?*wM_cXtpx_0W*a3>pG*E2y#MayGmYjB-$t_o5d_Q2Is(I*e@M73Tur#%X}mydJ>;a3-uAwSoWv_qGg}RuE9nYcT-|tJ4DlMD
z+=+AC&r8!-^@N!%2KEVZfDguXO5Y0D0v8k7TN=@N4Cw4^Rv>&%PEJ}#+7$RA?#s37
n3$^RtwYU}4y4REKdiwkSPNgt8k5Y^100000NkvXXu0mjfDvrCE
literal 0
HcmV?d00001
diff --git a/src/main/javadoc/resources/dark_paper.png b/src/main/javadoc/resources/dark_paper.png
new file mode 100644
index 0000000000000000000000000000000000000000..b04a08d8f49da7ee7f32cc5d773d1a1f9b02b557
GIT binary patch
literal 932
zcmeAS@N?(olHy`uVBq!ia0vp^MnGJ^!3HE_)+=8FQk(@Ik;M!Q+`=Ht$S`Y;1W=H@
z#M9T6{VpT7fEufM`+aK$24-hZ7srr_TW@0mi(V`6Y>}L+@!dZ9#q`f1_q?JKmz7HX
zT+aFClnzH@$KB6gtG*^Tua=!1^Va74V<58VJ0Jfy^7`vt8+8t+Z&-0}v-aNqpVz$J
z%=Z0WVzP<;>Gykg-?(U(93GG#X?uK%@s1N}$<;?p*lNOamL+bEsB)R7x2%_S=E+XA
z|EC-#Y}5|(PdR#LWqf1qwGFOMR?K<0{)m^$9^t(=*w!83l6L!l<8$Vi8)Yktk_+IN9KX=__g`3|^x|yz9xK@4VQ?t&ic9UzZ
z6*a7#OEsLgY_jf_Pt;u(uC9^0Ma(`|<5u0~8f~el+jXbcMf6_k+8PkMEdNfF_ea|`
z+e8!fcPH^iZ#lo|nqb@cJK9mJ-F6>JEA?@X{C8@}YvY>}z5g8XJe9R3;^K)<=^~A5
zIAuSEC$aKYmnbab?ft=1uNs#2jLq1y{?mhn+cf&m-dyawc{NYs%x07R^K#!@%YxZU
zrghA;se5Yk(@ZJwePyr1{h4gl5wGp0#Y)yc|FAE9eqdzV{#m!H@4r~ST`0)O%Y#!>
zQFTenlnF#}J~+J+)wMs0*BMx6c2GR
z{W+TLulOSN)9RWUw&|7MraxSN=+uki7mkTs{5k05*)IR)}D*o;i})A`XlE>+FP%*WHH}e_iq_o6I*I@M7{5X
z#liYomqngAt?_CC6*c^)*Sz@OdS62+RjRiA{I&Py*x?uw&JX2q3k{Bd!mkI2>uu|M=3);2e2?4SQI
xy3*#?o13D~mL#dYImg2PEuA%`eD;x7+%*>NysZ=RmjiPcgQu&X%Q~loCIBTny88eC
literal 0
HcmV?d00001
diff --git a/src/main/javadoc/resources/logo16.png b/src/main/javadoc/resources/logo16.png
new file mode 100644
index 0000000000000000000000000000000000000000..0d912d71345820e7d5355ca95baf877f5a49e9d3
GIT binary patch
literal 359
zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`Y)RhkE)4%caKYZ?lYt_f1s;*b
z3=GU=Ak0{Mwdo8{kiEpy*OmP`2OlS&k=N0`E#_?M)-yLzeAncAwK85fgHMlNH~oDfbf}uC{gK*|14UqBgl;g}#yd{R#k3Mr=YiHFwtn}>SA;C1QN!4pw
zBWz52i#l8UI*vxaO+KV2S0I}7@zReO|5o{nJqu>com+hb=zj)JS3j3^P6V$Q8?dV
zb6K{vxbhMe^XU&PTMzHr7JXya<(DRR->gQrD}``+JoIrH4`*mic$jbC<6J)gL;
zmd|?s4*{m0#~c-Q^AmU9)jPE|sVBd_VsG5$mY=*!@)xzNe!BgD()0au^s@`M{_)>v
zyXHy6b^$3P)$J>vZa=cfWsT_Kr`r!LT9&MPXsgc5?bqI_)O1ffd`tSztQl8bbanPJ
zt~>T{L-Dk=PlMN#6qK!AJnh-Tth=tWug-Q|8{btCx9Cqydc3#Ok&+!V<}I&n==OR!
zLs3>fBN?5vA*I?&Li7S=Od;
z?@)f{(OLTvIcMq~S5sXxUBlioZF$}F*|pC%#MEv4;BEX@Z1;@WtFHJpM*X>2q`x{=
zzJG^+_#>y74(>uly(6u}a}IINwBNY+b@EQrog$~#uH5>eIAV3Ij;%!c2_?7F=M#0y
z3QuO=2*2q*VV%{3S%JUy*?xb!zU@9&_m$^6_*;YLKU=r7f_uNJ*=={7x&J5g-R0`O
zmCASJuZ8&LPsI^$)%WNJb{A`AO^N>QUa7iJ_50%umwvgP(|b0n&n&rW@+Bt;-S|UU
zMP6CqXOw60%=?`0ed)>#t;F9!k_x5oMA9F6N366FG~RvetWJJV_HW^L#cS71*U)>y
zy>;5t3vV<&Ulp5ZWw^Fhr*Xj%{Y2A+({H)@-r4q~A!^^Z?=oev)pk>|{>Gf0yn4S$
z&D*_8_Wj)Sy!lwDPUqXp8_UwDu{dPk4tNMM79P=8@h2QGRX04-%9
zto84!zdgIfv-V-|nq@{aHpX5*n6{bm&f7ABK4qWFNAeD?oV#H4+$kG;3PjXj{QLKh
hfnna-O;;YvpZ&w$bn@N8cwqKp@O1TaS?83{1OPJt&&L1&
literal 0
HcmV?d00001
diff --git a/src/main/javadoc/resources/paper.png b/src/main/javadoc/resources/paper.png
new file mode 100644
index 0000000000000000000000000000000000000000..d646de4f73431901327a36613b6de69b5534c900
GIT binary patch
literal 146347
zcmV)CK*GO?P)Nacb`6e`ufk;
zf4~0y_1DLbAAk4r&p&_t=j-QRf4%vLZ}`}*hW|Lyzy9KUnFyWiPozy9Cr^Z(%=
z{^9HI?dM*9?X&ln&;9!Q-~R32e)IGD^VjdaKJWG2ufJd4`TG0yJ$}yqdi|{H^7{S#
z^R*Uxhu3Gk{(Yal?|c2s>;LbWU;l6K`ug+N|KDf6{`>V#Ti>nYK6gL&`v3dAec$VM
z_cO2mzqRq-_nG_I*BZU{zt6Y**}A;`|Lf=Wy{~`1{(C?F`ux{F_k6F<_WSlbd*=Of
z@3*tK-}C(J*>)E9-@fn8!k%G&zVr6_J)dR&eEs$M=g#mxcl+o4*ty)F`)B^{*5LKI
zuYbNid-rDRwP)YI?{l~2+c(cy_t5v+=k2?;CtDlO+tzC5;`KXwHt(O$w7a;!UcbA&
z>fPA-@9ypnxgUP-&i(${{dleW&feC<`{(oZZ0{cJd0wA2d*Gehnc1K3{r4T)NALXJ
zZFX$?^!mB&$Ifc)==T5hXWNh6=e^I?!u{SE-FtbTwx_$J`}cj;o?*{Cd;a=7&)n|4
zwru~s=il#d-S%8tx7X)wZ)dZ&{{)k?wnzK<{oHL(kyZ5fXe&_WZyI20+_NiynecAV3HqraLXWeJ}?)$y1
zr+#bqd*AC{PriHWrETA5dN1}n`<#8peqUeh=k1@f$KFBhrT1Vzx3jyS_2+y3=0ob!
z_p_ea+BALp>*uzHTWjCx_1A0NXXmsZ+XMGio1t&q+PE*C-`!E4S6gVDusgeR>HcmV
zykoP8?%}@ISkYK*&*whZ#?E%`S$1yqxAg&g2KROA?wvGt-2I;I&@b%H8q@7rcBgh0
z+>gam`}>#o`t;3T{_>Zfzx>k2cOdc(MBahOI}mvXBJV)t9f-UGk^kX9qd-#aXYIt^Q(HQpz5R0k_d9zR_uO~Yt_Wmmw|pkgy?#f(ZoIVh
z*t5-c@4OhF?0NQ`0#(Ldf^NIt`eoN@=X2}3`!)Np`?Gb~_cy*W7MUH`y6-dRvj&)I
z!}rXycLNCb^E}~8Ws4s00u?x4)5!rox&g(OE2weydRFjPTy-oJ=hj4oTmo
z-LuRn?Sj-`%rW_#TLahBy|BWd^WC2}px9qChOd9>WVg3_Mgz*NgHF>+Y{g>-`g#}l
z(o3f^H)!?T8I;ec7)15L%s_69JO^GJ1C;Hx&$fTpK+ciAes+7aGi|`HQJA6HIrH;&
zfj#?sb`58p=GOW3ojQU2zDdxY(Li{gtx>!x6YjfJmDl&XhWj3?Hh$iWk>^0$p)+~y
zsb_xsr8C%Gx9Vo)#J%#2S>@6RYd5^-2BH3W6Ue>KoUs9@f!yBTs-tIhHf{U5wbE|Q
zw(RWbC|>`r?b>%*oiagpjb1;u&)ph(hi7;9d#yG$u{OBddTjlBrdw&<&k2~k*35IW
zGq*rOCn|v88QuQ2tg!EV?ay|{Ow9DZ3#whK##Z|rZL@Z4YcV@({IGLY
z7Jy)ve$P9%=le}^^g_PB{KrQ(u~~se&0s+UcLq{NvOrI#vtUF7(uXxW-bFNMF3PpV
z+(q3%lfJNn?qMCeAtF*VwgKx7%#+mr{)v+8=Z03Az3-iLAk7||ENE1{PW%3@Aj;c6R&>lOn5k0~mZqlgXWNoxqSD
zDR!-*33#{`t;py!ysPe+$e8G?)iG_IiS*D;5hW9RDPUF}i)ee#wx;`?eYSVsU{(aQ
zRm|NhpJ#h%HOC-M+ge&)6VbkF&zyl~gKp2C0FdbU?2>2L=P7Ea&vV^G`aQD-+6FKN
z(FJ50NJ;5*?X|0(*X^S=&v*9S>Nh+yCJ0xh`T{##U(s6k(E!h6$usO7(H?5+tX6rR
z3%*!Y@q0ZF1tAOIH39TFi<_~TdF$^NH-%Pyj26ib%7td=15
z0y+;bU`t57RCQ36#?5{VGUPgMaZC>67@N6@ynA?BVz*3Gp16sK0pT2|iHm&XJ+qhL
z;(wP0qr=t#8i;9di}H)ii^^KgmGfQ$>Sb$o>!IBK`;G<~OCBrM^1s5LA-GdkQNdrM}nQl<`R
z?`iqcQmjFylqJjBd!89bleVG)I(4Z-O=L=)vc$L2vis_JY}RjOswklAY*HnvDksrB
zG-!8?O2689G^v($;aS_>Sb5s-?EPKu{k{Q;rTEgCJU1&dw-nv8+UKzHVGwV^QC@nf
z8gdY&EbJLYS)`>EA(GbNKJCAyXq2KSl5cQvJ$n%`tDBa1eU=8Eqw
zGpMxMDv05EaQ&p?Y(1>x>xbl4FSs;e+?vR{_g-7MZqilo&49VjweOJnC^x^fI+F$O
zzw5I*K6>~1j#g}c
zLzVHs?~oR;(wUi^?~BVF)&U#s%P-pRH(-$5?*$m|P=v$4qUCloAQ7OVr8*^pUk$JP
zbAsYL`76ZZq2|n1T!j@kUUhoY_H$l+Q~od!EVMXB5C<-oG+cD
z=*N|%U(Gc$?nMsG_MbRgMNOJfn>@CWq$rBcdFOomRuN#0uKQ{>-C)PHGBMd-HYdqT
zY&p=i^o|rE_vdG*i>7a_+>>%AQ8*Mnu}RkZ#e&-=fLVznT!cPWB6!_!;Dn
z22*-dX)mIV212gQ&dHu_$whuSWx2FBw-P>o41H3pu8&_Vu
zG1C0A=VhE~DLwja{i}cJe|J`8E|kKweJ(m|AZe9dTAWE)t0MMMX&0B6$7hMS#CZR;d*>-j77tIesU-!&O2FViIJLieQFXfH|)
zYV&PTXl;W^8U|hswCi9EBFYo>UEFuqwtrUD43T^9(?yHXM%t`s1+^js`j}SEL@)=&
zXusN1AeGS1Ho4Mg8Z7%yfhujDe!b1>{!_5fyIB!{+ROQUX_QhPE?Pkma-aR`r}N&J
zSPPz%@+RVJ0NbA{aCOmv46dsrBiN<#QxndMLaES1DOyrK1m8;2@eDUm7A!KJ=(GE?
z`pU*5Js-8<-n;gjNpIHX4q!6|`sH^&e=z&8RJR9O)}=a$he`vv?7RVhm&Huca;9Y`
z9lkHsMm;ZY8;>rzEK9Ryj~$Ksv$z5p=fsM=9p>PIbH>mW!eS<9)^~&8jL83
zWZ=|yvB}1RFYmBHWG|YfZxPp`txH%c2dC5U+=#~M1T29YEc-M5_s}YX0Gn<`DQJnS
z2GAtXib<7zR7z+`UL$WgO2aGy=zYQm)SmNp=&X|Uh5&~X@i4dHBKtW`}NstPJ5m{)S#fVAAwDrET_u1}l4
zJP%SHymwYQe1G5DO0daYIlZ2ZFFq?P%MYd`LdLcz6+MuN5pAKElU$so7#ON%xuAZGa{Hk4a
zeOeYWp)6NUJz5bpX&wd_QW`WOIsu*9KHG+_N^ctA%pl26YmtyM5?^T^%6W}U(7)XgI%h%LddGAynsor!0IDfYlChv*HUHfKoHK(VB
zYZWO(YL?vDjPBij>dY_a)%|bJ#HG92{uWENyK^=&iBguwS)TXoOUtySb?wgj{5n?m
zTfVQslWSuoMb4&Zyh*dqV=qE&xJ_DD)0Wj)9lcdNfrFiIscupycQ5RzY2s4(R)HPQ
z)z$Q9!++^VqUEjB)}ESp7);4A*I#)Ltzg*Kw9hMeASfr8ruKKA-=CFUBzRzw`=nwf
zaAEV|>}7=xD!||w^1WK=YU6e#{mP9O%@x?GY;z?|+b`rDH0H2zb@9j5&(J}eEz2L$Zbyd%+JrL6r-J$j%)vw>M|8qC{4}#(MHfxZ@>Ni
z`|p4F@*y8|l)Hp>J3pa{aybngN|%spB=@cXzvZ2Bey?T@4RPh@YQ)>QtdVSIu}06!
zt&qD?UYA5)(PA4dDu<|n6Jgi^YZrF~@h@R`*SY1O2542|@N!ps+3eJ{E}Cl@QW}y7
zWYNrK+E;hH7sW)NDk<_jpSaQG{af{DH9$$I88b6u9kY~xi&j&f_#CAHv^w@}MC}DH
z7raJKv|V+QmfKr~HV}00tH0ZG)WliZT4^Fhu&Z2Bx|fJt&u0UO(%=j-OOfiZ78_|w
zp%L{IQEg+k$gg(6uKkO?b}3*qVVCaE2HH|#+VtGMo=YXA6-&QU@S@63BK11Bi(1yo
z++~M5jK;G6{DpQ-Khw%Ws{&QXkrH4)sEw{9T9qUW{tH<6?`T_S8&vIuhw`65J|<8^WR3v
z(v3=UtP)z|xQnW*znYJ!l2I$o`Z1}wRwY$#D&5e&!%9~ZTYvuckAM8*4;!{qZk)d~
zl&8~=Dp+5%peh>%YUM0-NJXg>l`8Y|FCAzv)y3;Bp})N19==NYC6dhOD?N8L9T^}?G4ftr96nJa6Gf9Sjb+cj!I_DkPP>CidIqlN
zt1T!k=u+CKJe&cvL6Zq(Q7hM18)D@}`c@mYZ4kTmsy!Oo6cHVp!%Jx?%IKe&R5WPu
zd=w#-($*x*%Ad)n4xnq%q)LRd>(~Idd~AclzK_6)lOZpiZyQKk?JO0j_DNK(I>9Z)
zo4~93VpDXfD-CKqAJTL#dvkH?duLj@ZnE5f&t$g4o2(Q(Rj)c3@v;Yka{H&g$M3K5
zNEN3#v!E0l0WbSdifor2*o3GvGfH1Is5G#y2t$L!a@@6FtrU8uF2yKqtbBUytO<~b
zk14YxvMtksz&_EA_3_YSu=us)|Kdwc1$4_4c&+#+~-
zflm5;85t(L1({qw{Ym=YK7XigX4M9i9_+!as)-5`)$p`TKc{$gmX@;7Y|kc>edju?
zFO;v8fGapNkl6y2yKdR8=xK)sRj1a2A+M>%XI;l(77FA?1=ux_{^s1hrHX3?%
zDpRIHMw@yq7q_>;0HTsd27T8=)+(hm8EKQv?$R}N%s^G{r1z|MNfieJYTrZ2s0PuU
zAZb9+39kO!&W_yTqTf3MR`_hF+xeFF+Op?`P>ImX2QOOI3XykS1h>*?-rtqOM{DTR
zRTTjY;ws~I$=-FSMpcBG$aX-KcXOQCHp6zPiHZO0+1^o=7%4yY3S8Rz(xn`*Av#q`
znlgUQ11Lqp$#$Y_1`M-P?n~8WMjyE-W1T=M7u7Yfmul}Ua_f3}2WtDG42U$rqZZC-EL*T0MN~LT|N0vt|aBw9qm9Xt}
zR)_6f(xs&@YwsKH&F>pyRZg)L_=1A=)kq2Yx_=!45FFMkS~<7XsCv07px;v
zl`YcgUelXek}3SJfl(J#KCv6*@6^%PaeA=~z+8iB_g3DmQg;4ak%2bI$(t2rXz562
z?eCYntizXYSI)ITK_#lTcLoqO9!1OKsTKKcz~P@;V!gWT?NV=FffsW@hUFzM%HB!-
z`4t4Wn$f12PQ&WJlnVJvQE1bZ$}}SHE&pA}^&Ikyya`K7ejOz*syOG`9tHa>yt7Lp
zDov=v^K%Wli>@ol)-z-?ZK)McL7y~>*&745as@?$tLm|5ncNky+D;p`3j&&4Ub^F=pp9p&FjU8SNsGRv^b?c*3k-LV
z%wces1h6*PYF8U;w+1FI*EH&a24C0ZHD3P9LVc_pO-HV7LF6e~{xHxi;%pOBCx2Dw
z{o>_Hh%Z{xa#%<7$_?rS#G(>5)m;MuI`PPC@oGdcBQM9f16mpov;^6P5oLNh%JiaY
zTx(Rl^Xumf+X|(0y%FIc1
zvI0=lqmH7qr7O!93Fx|1cfa(bKCkQfH154pjh%X_Gi(D~xoy>lZh5*v;FJ7V&zj%a
zX>N{EcTby~KN(&@0!yQpLX3fr35%am&2y0{frB=$m*?0K=55CFPH3B*y4uA3`fksk
zJt|fzs+)XGRqc=)otJ})_WvAA)bedM_62_218_PSPGF@9BJsl5q7ARb^?_yNId&p)@7~+R{fW
z>n07>cTo~jaf5;jQqX!oI>or7)OWXAS#=nWXZfNqT>S)7z235jgwpleZ=Kgd?y28lim)fX-}M=Q=NVNRQoMDe9X#1n`Djec6R&>QF$2$
z15SL$CJv!KfBNR9pMLuC3_pJ?s%;Qr7TAWdaxV?0_HrJ`OHN8@JT=BE^HntYI-KPL
zwc)E=%$AQUU+9LEFXnSw!WQjpbDajDUAKKkD+eCnP*N)r
zUdA0f%Yk)d9h{>fs2rX2l4&yO189Z=E0PKuppOUGPPP*kT*(V(Y|dzU6|dGX4$89<2YXk$Bm-XN%V
zvQE2>ugRdlufoiA_d12NR4UI`_tBBkMQWu%?ss&;I`jb=ouGRSYbzhW3A!|qDigf{
zuQ%ZJ2E6`{1H3+c``vfneN{UV<*K-POXOE6{mOEDQA@z`N`0u7ORHc|r4tWCH?HL!
z%VU)Uv;;3jMpVoTaA}jeF%^`*hQpL&X_jrKb~z>;tj4nqrUss)2b7~&gIHNDdB^Tg
zwUKq+<#Nk0EzQQyZBkSYx?IyX$n2t+D7O6DhGF{$JS&~%ClXoV|LVjR9W^Mf+K-&L
zCZnB%b~VyePrKBYN;h6ya1DKXCN4eR23zH_YREfqqG)#$snXqA_U)dw>%D`gbc}5(
zds5yoFfXM+Sa_<&0W-ZXzjl
zqLTwJ-Eh(0?!Og-QX=+@oqy2Ef_*~`jPy56YP8oP#ce2-3Uuw?)sXBS7`%Fxo~jCM
zPS%D?oojWcw6Ov=rHU%?YJgG2jBAkBY_H#YDO5P|(Wd`4dtObO9R}9wSeu#KSlHn@
z<>}U*D^c8L-}b8b9!2VvUaqYZWVFK8Gj|Q1^ZVLBETXR-e;fufgbm}eJ|c=X+FQ$-p?O8db0{7
zMd6CT`C{W(d5E3@f+Bn^m&%W^41A4Y?-=AZrsz=I^gX{p{E*&qCD#nufY<=2I;iqS
zTavkWPDK~mShI$>q2ZlUWyxCoat)uQQ`e&ivWB?XW)(@4@-Zmx#5fz#e6I#s9jaj0
zyXaMuu5$A`I#{Gw$J?M*F?_j}b#|hXI_66W!C=dhr$cb6o>6*0ow^+KPO#HaR|3hi
z-3
zfCUw75VohHz=GW2CHytuGt%n%%A4;5-wt`{`LVQGZQLj6OF;^ghcyYdxwKmDZ5F-|
zM-wQy_BQrbuix)zQ*uF*4$!gsaH%>NysVO;+xcsJXVp=KPM!eo~sU
zN2XH1ZG0}BqnhY8n~7YTY*iMqlBOM$=KgDc?2{NjefwJ=XLn6HNB!~qp&(t8E5VuV
z>&~`kM?k1*Xw}^A`MZ?e)|+DA%helXbx=Fy{DjiW)UNi-Xn$o7D2$3!uvj7OUABq6Q6PiJ0f~0o9JJ;
zkd}Z-YbXjK8s73wCzsB#7x66OT}ew3YJ)pVf#r2w=cr{i5vz`0ufwZyOeZ#Wkd=Rz
zFW3P)>gU=p_%wo8d!RZ(yU}aB+*485qWYce*!Qn-zLMLa&?dzqDLqe@Y+}ccdr$ml
zd8tooGu0oiJk}FM$|UVl1}VDVW^kt+wrS90wN2Wku~b5^CDx9MuMYSnM_4Ylwy)q$
z??4r*DrwtcLzN`#{%Zpb3Z0VMKv;j+KQlp6(z28Lw3|f-OWi16yj86Fu}VfZnC)cJ
zCmM^kMf=-fc3u0@L#xQ+e&~y@z(~~hLT_7nkjHH-)5?vCIYphTR3t^kUi4zN!aLw3?@h!ukP|{7%f(HfrNV@9Wb|7z!L!
zcmA3g(Rb*b5D4yj8_%lxRqb@E_@%gh`TK8DgB{OYc`{W7It0SN!pT~l_-Cf?RJuC#
zY6;8Jn$wa$-j^2LbF^$}9y;n~%+Mucin1)$y(xOwX0B@rqz1_;P@Vcz#7<*)3D~zYTsa?;IVX;`TrEPdXKQ7^
zU|g+i-?7a@Qd=t9XtJkawiN1AEzz9v$1a|$Mngws=X!aZKF5$i`N&F5)yZ|lyTO?O
ztD3-a{6(S4g)4&FGgj3OgCqk76;njXs^U|6m!)s_(tz`607=yxT%)bS5IvK}OE_yZz3=Rw6EHmkLtd-3K0D|THrHR9vvrndt^T_H&3CBAclEionI>hW++5?l9mr&2
zP?}WZ0ufa~h^|HZIo$WHt$xa%Q_j=srE4$GcXz|;T!%xI`lH?NG~SC3>^j!InZTJ?
z?dNUSuATFp4EVK89oVD-lD@3dA?1&oL|WCYhV`YpZc;0dq1|aBDL_!4=AV~3Q(Jab
z=d4!jEEd5xz&1h9XRgw^gm|%mjr;oCOJ&Ll=O%I2NB8HK?aUWr_~8sm+V%)V`KLI?2&P)CR^1
z{$EXaa|Tzls>6{?CTwE$_pYF<*?r~1I<~a~4mvTj6X29#YExGwvpi?&(q0|i28A}l
z^!YRx3(P!2a(0!;v$3?D`&A*Rma&MR=SO2-ZCFM7JBh1Y;35GA>oz2bu2o03JoYw|
zboi7?BBcqrZ&!m>(bn!^o9t9HkX}?hvynnkIZ?U$(R=QXMJ5(X#-w^XrCYt(Ob+F=K@T)w-MJblwePiTzO=FLlq
zLwnpwtyKnUKZQTrvG$%n6QD|h3c6f2P2aAH%hQzTRfw+2WM%p~1LdNQwjtI#>hoR=
z##Y)zu{+K7qTjlQ0-c?<+gTn@Hr9Cg7d!FkgB!OjLQPgLj*+~aS2x^pbQ`MVP&oy#
z4KN~ley@!SQd>H}N3GyxIGvVNG5Z>lIaw7+G@PRKZCFwF+615tkZMmqO{JL$pOb?jqb(OwcgRa9>kS
zMI*}%Y(i;?S^irGxU`|Qjkv2iv~miYr&p^5T*{wr)Ow_8aU&o@JeR~yj_9h8Vs}p@`Qr2eD
zYHj;m?(6PMRaxd>+s9+j*kawtk)PaVTZbVz
z6v>IOt=K9nW*|`6Nr!tiiPmnZjqOk>@5J<~tMVW!T`I$Tb3p{@AXaEEt@93?X(g{E
z^_?yEz6fn6DEk}^-4kK1%8Ad>sgEL*`)BEaouWK@;u_XxXh*a^t=vBOLDA{j?I!fj
zXecOWZ&ksU1?9DYQp)sO4yKvCwl}N@vMd7MSw6YzVbyE*(m_(C4*F*{q&`vkIze>r
z;EZ!p%r);UPNL>?!tL)Zp=1RjUXC#V#$q1F#C-UbA?sj5VLBqeEMl+Yk+|kH7
z#Hv*o2sD9fvuIHzs}Uw5t#-)e>o{ByL<6J-fFgQTn6YA1iLXca}SPRT%^WTKTbRQY7k9$12Js_qQ}8oouyy4aRJ2Ey`BCU+t4Y
zSydmjt;&D4NxDEpl^Oa@<-%S{O4t3X&iQ4ZE4Nl9C6lfuN8W?oFKJTUKjlbUA#OFu
zyHq7JX#|x!tiJlCsBtxhUUHDi@pizGgUH(8?Qo_d_Xes(u#HPfL%D3H=UL6^OZlYn
zP2;z!zO}N^9)P}26Lf?9p4axCbwX<=LOzK)l=^BSZ#B1)z?HNvD5yW4kG$k(4e*U;
zuPUQJiahi7cz~9F{yJpm%P)N_%{p>KxoB19@fYI<;|sW?4(!;0|2ypRTiedLgLQYqxyW1VQw^y2;mQ;c|Md
z02z!G5!85ke*CUBaC)vS&v&%@TigGw?f=&He{1`{wf*1P{%>vn|1oXUx1E8{2HcJTwv$UE{>I)!pdmXAbN8!UEoy@$;AtMk%FOAX5~(y#i8Hs>)!%UZhUrt-Z41~9x5Mf-|*b;4%j3>R~
zs)Klcd{@tCx${?2r87}8ytY=!RW*F2X-HkW6q@8^m!E7;f@`qk-=^rR%23{R8$p|h
zl?GG=mP_TtvU$(76|2(1irh*ckW%M)YO=VXrPBj@el7{XR$#6*mzQp^qrcesUa;Vu
ztsJA(C#fs$jX{U@=z7Phs|bW#V1VD{nX%EkBe+F+uUMqKb`v#q;QQQ8G%RIJWveD}
z`)u!16b5}6|vs`*B}_Ydw^|bx^yo^_o^#f=^c5$MH1|0HPCIqWQJS?
z3=OfoW}E9gd>ToeWrO~r@=pzK<*)nwqWZo?HU0t
zpV&%?Di0bZwP3p!cF~uPVRc6pjY{o_BFh78BWxQtEpJtw$0TqGnDM+Zfu8N4kUi$!SWb;00584=MIoRM#w4@Hb
zllF>aI;OlO@veyhgh;W^CD(H2QO;-+m;xSK&)&-p6IvkQ**B2%-j9#Few%Apht)0D
zwV;H7L1`4)}(7k$&JTlJ{hFj@60D_tg3#tAC9s8nPxIdy1|~=%o%=Z@OXUGuC73S|
z(5qsY_RFA3+Muz=fpkn&
zzkmPx-~aIC4?fi4%hM~r%7EdT23Rfd(km=86}i(PUIw5O1B-qe*ot^|)M-mD)!lB_
zv(H(I!llz(oy%reQfF@2Pst*!-|FF6S>7Ygeu6i%;p&p
z$rrgREv6j1N_x#0JdH^1c-||?*t^tti6V6vQjx7T8!e-Ezb~EI@{aA;cK@#cx+r`T
z(*`i0E>wy}MP~snnQj>;EsW^P$z`YUX^%~m{7z{N
zt$39NXGOOCOQi&~Il28kF#%e;8^rF&hr!(guyIE@{=>zBXs{Y-3I?YKtPYvU^n;K=uDz*-f%
zt_qM;lQxvMf9wKODi2)MEn~b35HJ}lb=3-szM)jq-iKc~->+wGF!wa)zDgCk=RZ+GERhNO=XO`k|akAztl$9!X+k@7QeGO0t)s)V1NwGb>s|Q>(OGT4w6tsbU
zIkFu+s{yIOE6Ul#(aT97sn_8}PQFx&hVDw{jX=(k}mVYiwV_?n2*L$Jq1U
zVJAgw)%Eo*wTGpRe$q0kQh6Al`FVPP+XH*Hk?ByOm?P?Bz5UAi0{D^|K}+?!UcBHWC-T+qu0O&)VN)
zQ+<6-lcma6iez7E6{X?`2$tKuIH6K=(pxI9&_0&-U6odF@we4RX$V^0}!o~0c
z+kCWOs?-B7Y`K*!Z&a;C6tImD4O)Gdt68!rSc6&LQzv2|RVUYR@ohxtC6RyU_munD
z30+=%6B#qw4j^fBqsk`DfQ#Ts$r06)|8))PaPW|lfdx`sUAn{`1dY{>R66
zx9+=J_y1si$D(t5x8PDHw-RXw42
z^_5M^^^5Y*o7fA?_>B6x0wEPbXtLh93fEAyHXm!-MNg%NnEZ9Wo#uRvXct^-Bewux
zlV9iW9X0*y<`R5`vayI3p
z8vuGqi~N+Ed<93%JbR$ZXSY$!AVZ|Yrr3*m^fZr2Om)y{)ruS9i61>%d!H?J$>X
zf@U>W+hD6<({R^-l-pTJHqj@IY
z@=`@=e@gp5telpUT1RPLM}62O{b}OZQoqQT0aAk`?Q(&pYJb}-dQDCgP$|&R39${*
z+9OffMVkQiF-@k*S?;U_fsFP$c?ar~uh|hD@KZ#*{Azo78r*jpWgE2ZcPQVvL!(p>
zD?n2)&v(Cc^8#Jw4RvoDcc!TC^Dr+SmuUQWr=JX_i
z+^XfZ#!bLXaIH$UAEI1(?N%$81=R}bv}dpO*yrRtef}UiwT%&7a>4D!^$-|j*xX^G
zjKR*FszGekOnfdg-5n&=LAF@Sz@(t`a8$drGCNBBHGp0BxbIqYN~hiKcgv2KoRCJt
zQl=NlY_{bTo2Hag+d&*Etpm3MTQ!1~2c4GKW&}~-HH39A%r#=#ps$Uhtz@)ZdR0d>
zFqeE`(O65hZ3<~pc_9p<8=b&sqOtoV`fxSID)H&(TokL_)14ceZ9A&?_5V8Eu^dLr
zVnwPAR-H0t6JE#D?=#owZUEKqui{K);QX#DDb`{8|2sYRk_A;8-}~xx#3ma1_bRC<
z`?hmZbkPZiqKBezub`U!D%_c1yEXY
zH}Ml)GC-N4%B2l1MMbrR0u?^5_Ov#zRhX+f+91>_u7QF|G#y9ZijY%pm0N2ww5ke9
z*lyCJY7hnl`^?#q%Ja=e?sJ@xaml%MxZ5TFD8L~Sy0gBuD`=vGs=n}AcV}X_PCXkA
z?D78XOe$4cWfARNC2wc5ycgbg&uf*-l*%pF`TCy90nc8oI$#oiP48}FxygSATN>)lcatQ2L;;`up3l*S(yHFnrwN*v9F~_~YFlZRzk-Hx
z{0xT6^_delm=N<^!mA9@Qmls149&7dla!~C
z%thT*gz#`GiKqc{Y;-d}jd(fe9XQlvX?tOSUD-ON$PD__es$cjR0-Em={eN%ff2mPuThzfWC*1&`zD8SDZng-jd(`{4^HMdd
z>T(-&D%oCcUY7@w^hti$4UcfUyg`xrx4qdQ~+X0m2txO
z&Vma~N(C_swzhJu4eT3h
zg7Bf^mNmWxJ2v=qq_aUu=@4F011$ACTh4B`^(AlCV66jtDyJrTTaDTsF3V8O+^+^0
z4`~q}Q5rW+l)fd7ZER7XmU>)^3sLUyh)$#w2{ceDZABhqOZt`EGbp)a4F;J-5
zi`}-;XUZXL5Umrc12Y)AlnvyRYTOJ~uaV3PAml4)6jaKnUb)#_k&((MU337Qs%1ct
z>}ISYWR_s{o!0FY0DQM*<
zwKOf-s$=ta+BJP~K@CD})+r69N(F6Hv^1*YZ!=7dm&T)LR}Gs>6;2?v={X2Igzb`lXp$IY^t_OvWqWRh!o&
zrGqm>)hg%OGpRyArSc5^u4Ki@b5h@K>B^CoQ?M}zQ
zx7w$AjXKPZBe&P>RsSDuA&KUdYhdpo8x-+!b!QPgq~%UPBp9?o~6#N
zw|_3TROG92K;;nc=Y6Lk$>ry%-)+KIdWM{4*FdUMGtR3EdK`7pxKfj9phSx4RT+p2|5<5D}?`_xgFvZFn1
zf@c7xHofPk!zW$UD+YZ-{oj#fW?`=hku&fz8RSA`Al-ni^muy%LbKy833
z7@?-Gl|Y|So@pDn)zj`8Ulq=M{wR(H`0BK`uVL%hJEeVW0IOu{&eZI|&g?3_mcqTu
z1`6I=eWJ7-!Jtahl@_G7wIGB0@I;qvQ+JcH&byFO*D>k(*UHBB>|I=Br?4trS^elz
zMECQROSb2sf&!wa`jLVtCRZjqZ9XscWRw=qfOmF2V9(ipq^iXDovoZ(P1$$OZit#+
z{d87lcYbY<6{r;$umU-XPvtl5J+mTU^Sjk7ZBBb-^lw(nenV+}Ev!bsk=@cW%+%VP
zVQE{`!v>6&@(tSBDJ+_GA%zuIY@KINQ(gG&MT&xe1rPyaK?z+{2)tBjL3#;E=tb#)
z2vSA5pme1Lqy(e{LPF@h1Q0}e34{`=0@4W`0fEc?&;4-k%$?bDX3v>9-_F@*@3nr<
zdZca;M$E(qyOq0^#Ie|W?`YYFE-yyOWq@tX|Lv6bh$c_UhG#Pcn~NP{7XL~9>WuVD
z@I(A;RENFXrz}Ig*x49;ZOHsH)T&=qQ*D~u6p=^uvMS3Tk=D@9QcC&>3_L1
zEa!(D{$^IXan`0RjXgd{SYNd$em$63woLTHp+&&BkoW}uDvoPWf7rF3$_-EisYSZk
z!@Dm2qD(aly})B$-{O>NKj%L(RUxI~?93tzy%NEPnPc|kOm;r#7s^~d_7{o{MxFZB
zpp!Wh%HMYsef!lM6vppFyHOHPf=mDBTgt)UC|*^qcO!=e)0Gl}YRzUeM#gt}3qQj6
zT!o9cO^Y+ejoS0&2A?!XprVej$gME_XVxQU9)`bdtQ{F<{l1}0MxAEe9_r-;d*!E&i2~U?JenVO`ZDk%F?t#?HN52&BOKH9_F`%o;0g<@bDw+^dFWz>(r;(M%
zh4(zDfQ4&1Sm3V7R44y2wNG}=XTw~W$igmI3s}0ximqb($*jn6*Ywk_wnd{9)w57pFG6P4c)`5j@czTjah!A=w;l!B@Dfmq9nTyhhLh~AxD`94@$0O)$
zPN_caM=~I}dPvvRt7%D2w5u|PlMaZSjN8}
z$hnk!EHk}TSg1n$MYI{H(k_Q6o9V5{vXB<>Re94P&r(S0S}#6_xQ2p%hFV=s#PN9}
zoxfF&dc%ywMyOI-%a8vH^%P5_h38pe3MN%2E#hyNLm!8{^k%?kA~1sOjjD@=r{
zUz0W7AotuNhESbRtQ>?HU+g_^p4ILFvFC$KdR1}A56@|wRK`Him))v|RftF2KPB(N
zi6wp}b;CeeO0~O@EX_7aA?1<4)dz&NgeAm}Y$dayS3M((s{Ob3iAi5B0H1c#su)qw
zwcB5z#??ml)!dtq56n-eDp((FH&N7yd5W>Sh)yF~V_ZMDL4@EMVS#58l7~8Vsy6D(
zAnr+R32+qoR7N(=IwZ{dB0|fntI1AIPf>0S??%wV25DHvWWVgyo=g~{88Vrs5ZeR`
zC%If(*f1gV8=>1&OS|SlzQdYXkx_w_Y~CBWw{&V&v!`srCyY<`{Mj=EmTlrTR69FD
zVaN3g*y);n!>=quk|!cF&Cba$LtiDXcL!Rs_w*OX@BeCyW;mqJ-1DGBTiJ9mw6R$C
zGE=IoXiFTM`k-p3qE=ec25*XfZzKamek6C0iV;Jr_UVh8_4*iA=#?guVwusVUhcf)
z(4-5Vv+`A5+XErY{H|9_<;fyccu34Q4tPyw&lxd%;JvuZdM%!I#{NcZA+6ODiW*=Y
z#SEA7UQ^ik!{s>81Jg_)k)FTrF++IwbZxvt8r*3f+kraWmqc*oMceX}PSEAjOcRAv
z_#u@|Wv#u`>9j(@fQLWOqZ8IE%1aU`3+2INXKzU`b(wOJ{A&N5l4sYWFH{cH!X48XkBNo-inb0KV1^dlMBya
zI|bq3200M~+4)d{UxrP43?UrY`1#Io&7uO?-NPX3-tN~!)Qgg)=RU{y)|kN27BFjt
z_+6PN4WtnI1|ii_#nGw_Hv+!3N#I~~0B6Lf$rEALwCV;3-2kdpH5Ka!)1g*f2Kn@A
zRlM?SyF
zs&W+bsXJbBw}<{maVCci>&hU##S*O!&a{=AP>^LJsGkL^vz}jb{ogiC5J1e8u@zEP
z8KouNqGc3T;;yivU{SY=_$0K{rIQZ6}
z?PlP;iS9QFY&_ogVwK@(?l~_|N&fOK8_d9Y&C{j**@J3!!LeP)?OXDzk4JZyo!O(u
z-(7)wm05k?eS}gS`J2GCZfqYLD9ku%r4=(~f(y(0w<^>m=j3K2num}DWV}X!k;l6I
zWPK|Rn#9jSH#wd?aUDN-gZe4-;qbR|_#y`NV0t?fiyLbyLJp=`mOq4TSds1pCI`KfJnx)ljg-q14%Ve3;Vqo?W}BnmmoqsUQgW_Sc6K#}xF)xwxU){)6vO*Cv{NP#IaR
z_&xuqB$!8@(fd2r&|Amy6^&XX1TTKDqGb~HnaX_5V=k7S?`pM=hpLU)D2648oiuX4
z^Lr8dEAx^S6+3_zmC*gWBc4U%o#iRdRT*LQmk#LmNY;l
z0BoZ5mI3pUHWA&Hu?DQHb+%rfE*RT)Ta)oKzc`J=R~E5RofepGhKDFV5t9GPHJ(9u
zY%X8JwQQH&udVH%@+sZ9=n~_-hQ=bqDmK_TslO%DZ$Wt@BF~3LZ~zm3N(Ds7Vp#8ClA`%VH5_Nd=9+w
z+mV(zP{u^(#L&Wgs00pUzTs?E+#wJu#s5SyxcImiGY*|owk7YbKnJcZdNx&xG5msG
zz7S7;u#r*zfzmzGBD9AhP
zm&`?52jkU{%f1vFM35}s)T;VjXJ($rjzZ}ZV-0QNAHQCj3^CG*VP9G4)V`S
z5(C6ADAwKQgLQcj;gzw-u9VC`(2rB`_<6{2k#-ka46u^WEn0BQ^dCZ2#vlBHeIN+$
z3rwQd)Eve|kwA|5Eate`4R8nv;dgVDJl2TBUP`4JBmedb9xeJQ1n3*6JU`|O
zSp>sx6#+<#gGqk*Ep@5oIu^;JVoXt(k$7qk{W_IBvdYf{=^mbhWu%DI@?88D`ZVlQ
zJX~1K3{K3JM49vfmgv=kTuKkvl=9e-R_k!E|1D2!aq$6A+x^F6oQIBiBh)9#e3FjL
zkkSo=ZMVj*Rwd+G@_F%0Bip@4%ONt_3?yySFm5I8AHfZxxgTmq3TbHzQ7^+|_
zl!+Vr`$VY*qmS*Eh?MU;!8$GA`=&GSc@rC=gQ*I&fB&+e(?i~UAlJ;8rrf4Drq1{c
zSpnrxR|Tmt6GbLI9Wu!>QSBReb~6P|3hQTZkUcVsY`83bbD5q2z$KbC%ji?_6ZKML
zm7IMK{cg$P$;;6{rUtuc`E(yGJ^hvMUatE(UiY1DF~s8FNI)J1bf+TH%}P%^_3=mr)K~IG)F4!4lkvopc+J(o*TVgvebC;62}*
zZ36zZ_>&)M%ta<3XKNyKVUU9wP-qFRV!`6GsX@^$ew(o>dnsnuLl+7%S*Xgw>aowD
zo$hEBZvs2d($x+D$Y4vLgU7Rpz|B>H^R1!4ntsr;?exh>kAvdX_)X-2*D;Fk1w$ilGrTwqYy0Ib`-Fu9^GZ%~G~KeVfp-c+zqbT&DgbuRE`Lo50uc!X*%_&Ubu9lvISllUq5?uHM!dNNMv
z7BDvVME=DPF;g;a<6HwJa%g-hhkF3{T4!`$o-!txV)?CaT?KsA`<~0rn#D*pEVKCi
zubG#^+DK(;+=Ik*_y{I6@_|`Eu{)R}=8qu`Z~3O?i~#HGW>~u~BciL{)_x)NQ2;A0
z$Qa3?H_Z^?O-@3o3wR_ilTvrd1{-veAVZeNWZk3`;P;`jk+J2GRhKaVr^hUx@M{yjggz$Z
ze~$VPX))<3qFJ31AGPM0dgl13DSgDfztVMt#H%4(R1nUx65poM5y@s(NQ$MJN!WzM
zhKd$PegNu@33%URZvvy)HpM_fv-PKse~0Md3y&tCiaQ3
zEH|ye(x28<3Qj5AgDn*1mWAv>T*^2X_bq`ihQBhx(knS|vzpV-=D%6BhHiE?l{DI)
zJkLlHsHspHpsFB~-(@^mBq*5A6gUCHw3
z4sW3XhdL%zR6-+A)0>p-Y<#2VtgN5ps2_lCCZxZO(1bR42z9*+FAnPssPLV-)9&|L
z&i;e&f4l=t@?I%7+BQcvr$-x)SH^-x6PX91-o~7bhFHyfWOCeN#!GnoK&SkBd%^^0
zx8-Zij!$t}u%0VYq9v6VVWxH6*e_%2;q%8@vjNhpbh=OkIGi@A+eJ-6U(2Cru9
zErFdoC|wDX-g`Th8nC3Ct7wKg&Y`dznub&)CTu<5b?NWN13A#AeuIg@Y#H?d6eB^&
zc~L|-{xNP;u}W_<7_;!(FbCL3d?aZ!Ep=2e+c!j9B>$FxZ*bHuD?htt!9U(vT
ziV|GFZ4y66dUY_7;{KIrOQRe=jkaOq4X3Vf+xFbD;cumspl2XV3p(tmH!Y|mNzoO}#s@_ZvZ=$%+&Yq&&uK=4fAHL~Po
zlM7Yaw-jSJB=JL23nAZQEP$G)4Dllmj4GxoNQG}nB}q9#XcgN@pAklLA$pb=N~Bfp
zp!ii5}cViCRb)nXX<bp=SSagy~*k!j9WX8j+W09Q|Mww&O>l{rrO5p9bEaNF}&RZ!ynBwlX~ja
z$)+((;#AAo?;t%m;dvU`bc{xn3>vHBAd5e{*_Y6H-#twArb@1(H(h2=}dxE#s2XM=~D~-@z
z=itL~B2OXdx`+bWc9wsr9E!Z#6e*A#oO*%jg{m}a#KN#>lZ{llJ(z3}&@=d}50sK5
zw|wxt^DUX7UJnp$8GFQ_Pf#v8HVp3iqqz~d*qatt$&X`uC>x9^ZvY@{K^PTP<^@7|
zQl`{i!+amTZqo0KmWP;$JdH@4k&3T_vXG*KuliBN%>hOA_b*rOa{3Te%4F8H808N;
z=?1^O8E||c7T~N3^jVObM)P&;5fwi%1B2%$xSSg-y~!?Ukxo+4o|4ezFk1R
zPx|nHdqVK7yUfyZ@lyTepE=LLeU!Y1B%v{!;o)%u#K*Hy0iTi=k*-v$f$qDV63Uk9
z_;kHhEK7f{@FI;Wc>F=zfHV+(I{oxg=Hbw4QW|USBT5ZpxW&Ashf5j`TqPGoix|
zyEsHp=q#erXjBA&oU7yRL51d^YQSx>P}Bv`Bw{+f%nKvebBGc>_mSB8%5hnj@4G7t
z7J$-aLT4_`Yig8ZC8O#UVW+i!0N?)0>=+hv?3cc7md&CE)g=Xnda{;NyMygrk-lV;
zv2AD0C{Ld|kgBM~!Wt=MPl(?Fx(wlEPuZf#+L&-@VR&jY6KT-z%{_AT#TWdc1xA;QAw7dSfy*Tgnl|Wt8
z4Xrj5Vny9kDw{1lc_>Y~o(pt4<+ak4#*s*?Hbc3m_d4yB(Qh1_R?_a6+Wf{mf3)`@
zRk3rrQGouQw-XoVj}CWJz8upX*HDAHH3q(W?`f|ZG$c=eFZ&O0pQ9tW(QrFCm9rT1
zG*Ana0A3U;EJ=0%3;x@Mb9q0xTkmnIT?pCOlUl|xg)`bqPt3GtBhCC0*>3)GK1Sf>
zG0hUCP!g`KW-6Vvuzn$3hUBAE+9pL&wGC3mtVg})EOewV*1QJMIPR}V#dRi~oU@mv
zU&TJQ;ZW6YFKiYfKuNtp)sfRDV^QWD#Zj+)zN3Ab9t~^tJ;kzxVNV6eLWn;hWuW#=fH
zn#WMURq@|!JjFoQ3ew5ysMYLHBbp!Ux|QE_s}XFNwB-jG_LO)suNh$DeYVnt6ro|F
zQ8L038lQb8$}wqRu~%=tk=*yG^Phvp>z52CF~Epq>zXf_0f~><_+!_Y^BEoEOLBNf
zmc@moqJT|*^FHF_3+YJFSH&XJf0St-pYV#@bj?zYoqU&{>1iMp`df=Q_{V-Aq;nUh
zur90afQ!jy{H(i!sK)gZKD(?uJQ*N5U!F{EKLLIxAQ_HOI|dL
zSrxpKl_bd2{?3xS)AuKZZA{1eBV<(nOG+BSFbOXQK+Xp_8B^W0Y&Wv4J}1Z}I2K!EChPa{F23cYnT@Xfi~Cv`Gxe6b;UfA{
zTg4F=`1a`d9=KTts>;u^P@`)0kyh(W^m=u}D9M}Fi!D-kxOrjE{}6xlT}x1N!-~N-
zWss;=)P2*4zw#6IU%6(EM!3Oh*`qkK)Eg{Vh~_{R3dQRpBxYRpwi((`$g32O$w`yx
z;9k=r=f}PypX`4=ZcGU*cXV(vhr~A8Z0Jf2N@OEBx@G-__?XS@`BgJn{3&`Dx@^-fk%`*5$J6=cxJR|xmB@inrnDgXCjf!S*dr|ilm}9vNX|DYnu`N=2ut(fgqmio6
z0Ms;9ZMx8~w$fnShr5!3n$pXqn0^icyUM*US}#qLhMMA<{hdagefFg{h6JBNIRrM^
zF)v=&mg6`WtcX^EY#WBR3^-LCU0zS^hh-jEs-G9q6@}Pl;l;Tq?N%M%$#-Yfs6vSr
zj-@e|27-hG7}_{Ng;A=6cU(c0$~$|-48LZ2&?v-^mH2VTb#vc890TKeTtPP-5BIzEZ~dG6TX=@yxFVLP5k7GU
zy~X@5FKv&6uP*B)x87`sKuQqqW@yS-Zn453YmM&mLY8*~dQwEFCK9@=#w;eG+^}n=
zB#`SVoh04fK0jB<-m5Z)g2TzMrR`{cKwF7c3r4g+O$?^PDVp8S?Jc8gcTv
z@YV($X4WuHI&3`U15~U&Kln1j|M!en!OwMIBeQViGEWGLqKto=M-fsOqkTh7qLfyh
zPMyx?$$R6UYCVtc1*laOd=SM6!B#ZDH>e4RCQHqv1DFZ=TteTC;M~UC@`U(~Y(!zp
zi_&vSBH-?5J2#wO1U15{O)-Rx35PUKa~2$48Tlnoz3P@2XuJHTPO`sIyk$t%fdEQ!
z82GA?mvqxdsw6uIz-lum(>-*n1-?~Mcav4UV(Gibv#{}Bt~0dAtPzyf%|%T}2Ie74
zZ=SB~+C_XY(!)ah387y)70Q`t76RHF)C&r-S~a3+iN-Pgyf
ztV=g6MEpBseRbzGX(=(?bw}{S%2rHfoikSX=EKCR1MfilSu!i>wtty1edY*NhBCMc
zb8_Q-ol**&=%P|Cc{RlkBVPQF3T@bYm1v*XAd_)mQpr^di-s3b+=TYCeR7ArvK+OM
zb1s+iSb~IpS_WJeEpxrjVvL!)qds=U9Cb}8ZuO7kt6Bkj)L!G?Q^Myv55C42395?v
zoerg^9p&2-3sYSYf6lLs^yL=^ntjp)?Rb&i7x|YKk@LP!5uRsTPf&7`cYwIODBehrrJKOHmsxw14%V0X67BvF_7>{_0~`ICyn9G#&3
zHcl@kc`SvPVVh38wvo+B&QV|e&807>iP5Sx=1V=<3O`3@
zH9vUX3w_cQFJqeF4=67(>}~
zk=6S?oOv8clNK@&8g^IaoGLI%Z?foq^vsOh^nX&I&~7WVMj!AugS2QFG?0?p!Jcn>
zJHc1wU6MO9FMDxTcKY!LRr!v%)MD+$j268cOOfB6eRIvlQjz(^q2(HSQ1$NEtg$Ye
zi)z5KE=AJw-Y4bd2*}G~rv#l35-mB8J{!SebBFnP1V(OfHm%vpyeN783d!zHfGgwX
zpTBbdl9?39JyIny5x?(k5S4svs#-kDXa&gpl6l_jA5&`B)mqq_^dd@
zmp}d~+uH#x9#BbSv2Gw?HDbWt@SEC5n3}I36&E>h)+CTMQnDJ{kcEFEp}0D*<_JEV
z4Du-4u6#I+8}aI=Ts5CQMBBk6iB5$aKKg7inF&V~v8>#UZalexHw%)*J>yt1zEAk6aHcT3`t3fGR4Ul?U
z7p#kaFL^iR6BPIPQWCVc<6}UF0{-yzNyE}J4FN|=>eY@kN||J?)J;y2n_JExl5M@A
zJiTiA`t6wQnb88X$Wi`)qltn0LPNIU^~whf_cnsxu-S*^dj~sL!YY>^A`S?9-_r0o
z;rE_iPgbjLG^J(jc`BS(JDzOgxwCUa^rPcr+;LgYt6;loxv;zmtVK<-+4`j?S&gk>
z7F~dPcQ2PRC*S>Tut%03PL(Vieg+q4ZhR5?PAeAzD|RRyaoBOJ
zGedp$es}n}mX)lvF~=b0UFQe?sLF^-M}o5XPJm7)y9PsQTKM(FnQVr2D3v+jVvhm>W2|pKDGa+^h!)0n1!lb$K|!0oalS|7?6WMGU>J-wJH=
zCa0J+pZX}qtWEkkJa>JaZ#a8s!odcRzs)!essE*CdwdM&*V;}Trm06^*6SF?N!C)a$@
z&DcgaLC?i4Ep$5dEmAAeHzxvaKfWuQMXbo}8@}#k3^zE+3=yW093r{C^O616H{ONl
z0A*ly!U+t%2QtjX5$
zaxLlQ)xzzt4kZZ`2Fk|u?f!{FxaM!M+0$QAjoi(~8qcmrvs!$ezPTqeWckfq6{M_1
z=N)hHP8??Elh);zDn{e2l>k`C_D{d+9BNguE!lk}CmD*GTvp8kL?FL*sIaT#1c{kz
zt;pW>E715alGigWjZZqh#(tCg6_3fn-F|H3ojt#F9aDSApEYGhuW^W-%w0w9Pa*rG
zzSy+ROvDTB{|1_d8&y-l4ACS(mT}U`%!Ib@C(_(Y{%;i(Q>IJAiuv}AWWwUKSZ(s_
zp}9qb_s!T$aSk-Q*OM1xa{*bfBuh(czVFPpvW~@7jlgzkmsaVjiKL!NU$gWbX0fn_
zq*CA}L8x+jO4Yz&xn7F}uhIytg9FJe<4#SRZvlo^SW^9;e8bt!a!9N!r%QB4dpG?N
z7nzrRR`wjh3k4!E|MdkPF*nh2R(;QN>da1JV|&8K!1B4$l*AWD(_ow8~7d{XI})ccaYCeZ%hSeX4}2a_w>&9+ET=htR+X)n*@^H
z&q?l)YkefP$O4Z_{I7Jh6+Bw|mYHld`RmF4!s-W6qk1{2aG8LZ{-)DS5v`7U9S9#Q
z6*)~*nYqhRrO*|iFuI8EW%ZO7>|vTQbf7lWv-%DAjjDH3QO>N9QEf^E#!`CP{VH;6
z?XQEF7SCRqzWPl8S3H9EA``y8>Yq#g?Dm>YvZny}7pNYf0DaPoc`;xrsDvgtD8n^|
zv<%6R9M+h9f)Z7n-!wJw(VjZuHU
zBu4(kx**`lYdw52k{Jf%K@)vYzq7CzimCao7I
z8+g~g9qw^o9zL(B+CJl+#JV5m6$4{2tNP>)B9z#;ORryPBB^-6rw@38d=TL>%LFF)
zJ|J_WTyC9O&wk4EzDi0h_`A?%%K72ZI)l`mRX_;gUMjz9bz`r6I39chac)|IV((b8S<
z9w%4v*P)d{vz@*c`z_yy%NraqlE07~9kWCE)d>&LDnA2Y3#%e$_@OZw5w>OARk`gF
zok7BF(9Og)(U0GhkS}|zh-%>!#4Oooepd2VBsMBz>};gNQ!xq!YmLTHCDf&?H|MGu
zKBLsgnO`%k3}aaY=na`8O7hpIE8sE##etuf&)7D;=T)rg1EzS-$9ys@Dujm11741q
z{o0gJ@$(fLdZ*)y91PqJ5RNo0E$NG8X@64eg=$;PjkUw6S5=U#YY~R%!HIG8Nu$-5
z>53R&^}sik#_s=0Nu!ZNoS^P*3%37k7*ZKO7;&(yOo&dm-@C&0R_TN0%k<#Mtk=Bw
z464}L)=_B2lGdMr7TAvn?=j~H{J{_quWRJ-AwI;AZ!wS6JT24y93VCeIycTqfS+KzXahY!gwFIeW>;9Xr_x)bsj<>@*kkkmt4H
zTW`9Wr?zq)atCL(CezDq6Z&+J>;&E~o<&+7bBHH!s^-^b!S|tS<)DE_k8h=#g^b
zV4d^&V^>I!Rcp30WNFoe<0Eu;!dg3%zkDCYORIOI!IFI9fhW=QDG
zN;~S0r!ulo5z;9)i8+W=ymob>q$EgtFRn`%_Wfs{fDDPAMSQsiv`gwCjCvq
z%$>43lHZ_|cY9{<_cJ%L4t*QCW@|Y2Q7!uR-uZ-f&6TO_jdvS(ZR34bA%*!vCkU8z4FEi4;3CzA0(lFS8-oX*1
zy)y>Z2b;+@{wSaQFPVf;ec)M5C|_5G;s&>C7K7`=c!NQ_Mk|Dn=*98mnUYoxFb;WF
za?VR2#;!#&$Wh|w#R`UJie>!fKeJhP_pqtp!qA3M2m7Pc@wxGnDMP2I8IQvJPJ^lD
zp8HY?RnF1l$u;f9PV(UPb6Zx2;@Y;(opH43!gs6>}xi&^w}s=%a%BS+>jKdbf3zkel1aT^mde_V>8%J>$*!xKVQ6)+YC`$
z&~qP#YB%3noSv??bWi9Hs7gT(?4XsMO4=d{xdQT2t
zzq0D4OwH>`b++`gLVeZJC}DCFs;C@j39DjBj%ABI=}s7z-YBBCX=G*3IM=r^m)|<|
z6|{ogp#aXvuFe0=2Kk-O;#4a&T5fg0W?Y_<@-uJEfjLFKB-_{>y3+3nYhWwfK76Ce
zG_UkNv`VW3C_JR@u5OAI6z=@TZGw*Lcs*-pZNHnE>Q*p$bQi465+}1b%us8;&XAJ>
zMuFB;iTGZ-d2(X)o9hInYPQ-aZ1wkF190BKNJCVGi_M#$W|}}R59g$!up~~n%1o;y
zcR>7$(5TF4U8ySBX%7dFh>@m+R9w6;YCi05l36QFd4mnMJdd7*Ooubl7%MwAu?U96GD!
zT?4GMuSDk$W`+ut{j~&dYH=mxJcb1FSs1x30yv$fr>j!(PuVDRFLHOXF}iz=cT`b3
z4$b{Pz$H;?e7txg!gWH)*i!NnxUbyUZ2qJ(g9>u=z`o0y|7r@(sS1DUT>S9`|8$X(
zM{5jRJ+>x~)r;71V;(|dW`{$V+hI#QCc65N(9O&=eT(h#vI1+3s%5K^!;SlATjBQ=
z%;)LmD_z{n+Q)iE^TRBI-35^PYsP;pd)*VJr*=kVUJbc_2+0mLka?;qQPf)DJglg{
zQo+i&MY3{-Fm$-f@u)*xE6TMOpBf#t?qmxX`clU(eLaogOJYC*CQSPV5Ho3|au2^4
z=?~Ee+T&TQWtB}m3rKbVtj!IJ86UAzj6A+|`z+~-(VOB=(99X~R3Y1{ZLM>h?g|Ke
zt(Z>77K;r8_=2=!Jo@sG)=d(W=mgLW+?k(nAj^|VGk8VD=(05EDM`(egWx`dk<$b(6Ez>=
zf*etbt7MGC@HcIqseAES`>Vg-a*|yiWglh>$)Ux!p`r=O!%=EuOAwKvH>3BGCaqS8
za2Bm*_a-rxMf@{qTFt=S4EG;ZT4XP(ts}~IT}+UyTbiHc2MX{b76<>sd8@w~O0kfC
zp3{qQlYCVK(MX3@alys+4>?NGp0o;$d>S^x4}2W$#{xf<>->H~=o}>!Xw&8j1hjw!c3b
z0H^j$RK{yBH)A7asb9CbwPK_BmYpeZkoMvj!bLRED6_Y!SVhV?>Aq~i>x2gg{j*xk
z6oc9hF)gmhMYyI!$+wVQHe+&FKDRSfB7-%qRBl;)iecWbdS^dR*K0M0RYzL<$PE==
zF#$>Y*`Jg$S~RhnSNx`s!zj_oYXvW%zgfJTL8kSJ0ojANxt}aH7Fi~7&NeL8FNc8z
zPAeo+s}MsB_P$drNiL9EgbDd(ED*t&QayZgBn4{ZWUi;Nv;HH)&MRN%K=y1(USB29
z`a{3ILeL42a@7$s)g9XU%O#ERT_L;V!_L
zY*F}|B*m6byLcskPuj7%Bn4Wx(-?)KjA7kE=)g3{NoAcJp5q;`{~4fXRjSocV$sZ?
z;1n%OHhOAHGOpMVGEshh`QVI$c8zLTM|g2<^i^(6Ks-I|(D!-z8_!(U#jYQ_1Yg>T&vLEn6Su_|;|
zk6xg=R{zO+$(N~)0kK_LA6e->1R|d{b*^xW6>@mgBRHtv*8Z6S>pR{^hSsvehC;9D
zjMZ5|6t8{m4sm`|(B}deC#kADHt-yRpfC>Mn^>JjswaSaX=6l~C2PO{oNSSyRZr+>
zWgb#Qeo}|p3_J}tb6DV(DIZh)MdGi1ZyiS!U;XOvEm^RHZX_WfTy9*zAr4Y`08v_=
z%R~sJDCma;a0agBc*8CUcWE&L6L(y^zeIIgVu-ppXiuY(LmiRuUzLa`;M*heWX+!_&gnQoj*p=5+b@lJr(vKubc9{xZR9;nqxzB6r!=|ZtK2UvjX6@j#ao#QF5osrst|N$;D5_rBdoPR~#Ib
z!Kwkd>|MRAY008_xJwFTK0{JAw8Jl_EuwqwEOV7f^~sWzLMcWew8AjbM{lvB5sS7v
zHN_o|;aJ&&X}Zdw$q`CnCMS!&UsY2R_nFySm;GY)rILZ;r5EQ%UXT~wBc5bI`*D%s
zbPWZ;$ja?JJMYL%(I&W51?zrc+hjuDTEhCoQg6w2lMF+T7U~gxyAhb>1+fOn;JNBP
zwYp!@Qo8YR2Qc!iSk=akQ#h;EXPO#4HSrbNx1sA=MCr-UF6mYQt1@nqlt#WUNZy{doGe!p93Gh*#ltoUcw^MQ2+J6aav@$;gAkjq4+
zg3C%>M74OSk_I7NWt98A
zAky1Ae7Th7+fr}74f4yH?bh?IPGzc_6MDtD?KNMCi4`z7_t1;Wyuj75XzCXQH2b
z@jhQR?ONU&kG6DZvE)WS(^(2OmM`O_;A)c8{-@nE#Q)njYp0TZz2o`MZ#hTEZ!~;Y
zrU&7vHXjQVibu0Xwws!`
zz0P##%2Q>x?N?@3IZjHM?)c>nA}9(f!6F+-vBi-{GX0^0Kb2c=sEwwpbYf{@47><8o=0EEYbwnXYJ>_wrHei
z1*nmQX|)p-_=XjN?A&=u1o@)%E%Po^qNig}zTZ?fUraTN5L6Hj0X)qUU2kyA4k
ziJA2h(kD4JZv>Q5$lb<;X+S&DUNIs;G1}RpOS5@$b~Y2{IvZEuk)@T@ktAn~7&-y_CT(o2_M%yx;tWoUUf
z$@q-GZXny3Wjp3M13pA4f{$Aq@9xW3eq`i-Vj`5P
zvSpF1qcK<0SVsTm<@?ZWgq4r}N43DzdC+ZBh1W;LInrl(aE^|s%TcxIC@Y(2hJ
zT3jF1Uwt6)w_Du%+lL7B)lz>Ko;~JGPFwQOc*Nv`Wz&Z4fU1YxXRN}e0Op+ea`WjB
z<%$W0a)lHJr8f@YA01U#DxpB9HaE