ziver/zutil
1
0
Fork 0
Code Issues Pull requests Activity Actions

Fixed some javadoc issues and updated build version syntax

Browse source
This commit is contained in:
Ziver Koc 2020-01-04 18:49:32 +01:00
parent 33fbe0fa30
commit 8ecac95593
14 changed files with 51 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/zutil/ByteUtil.java
View file

@ -110,7 +110,7 @@ public class ByteUtil {
/**
* Creates a new byte array with reversed byte ordering
* (LittleEndian -> BigEndian, BigEndian -> LittleEndian)
* (LittleEndian -> BigEndian, BigEndian -> LittleEndian)
*
* @param data is the byte array that will be reversed.
* @return a new byte array that will have the same data but in reverse byte order

12
src/zutil/algo/sort/sortable/SortableDataList.java
View file

@ -58,9 +58,9 @@ public interface SortableDataList<T>{
/**
* Compares to indexes and returns:
* <0 if a<b ,
* >0 if a>b ,
* =0 if a=b
* <br>&lt;0 if a&lt;b ,
* <br>&gt;0 if a&gt;b ,
* <br>=0 if a=b
*
* @param a is the first index to compare
* @param b is the second index to compare
@ -70,9 +70,9 @@ public interface SortableDataList<T>{
/**
* Compares to indexes and returns:
* <0 if a<b ,
* >0 if a>b ,
* =0 if a=b
* <br>&lt;0 if a&lt;b ,
* <br>&gt;0 if a&gt;b ,
* <br>=0 if a=b
*
* @param a is the first index to compare
* @param b is the second Object to compare

8
src/zutil/db/SQLQuery.java
View file

@ -257,25 +257,25 @@ public class SQLQuery {
return cond("!=", arg1, arg2);
}
/**
* Less than (arg1 < arg2)
* Less than (arg1 &lt; arg2)
*/
public SQLWhere LT(String arg1, String arg2){
return cond("<", arg1, arg2);
}
/**
* Greater than (arg1 > arg2)
* Greater than (arg1 &gt; arg2)
*/
public SQLWhere GT(String arg1, String arg2){
return cond(">", arg1, arg2);
}
/**
* Less than or equal (arg1 <= arg2)
* Less than or equal (arg1 &lt;= arg2)
*/
public SQLWhere LE(String arg1, String arg2){
return cond("<=", arg1, arg2);
}
/**
* Greater than or equal (arg1 >= arg2)
* Greater than or equal (arg1 &gt;= arg2)
*/
public SQLWhere GE(String arg1, String arg2){
return cond(">=", arg1, arg2);

25
src/zutil/db/bean/DBBean.java
View file

@ -48,19 +48,20 @@ import java.util.logging.Logger;
* DBBean will be replaced with the an id which corresponds to the field
* of that object.
*
* <XMP>
* <p>
* Supported fields:
* *Boolean
* *Integer
* *Short
* *Float
* *Double
* *String
* *Character
* *java.sql.Timestamp
* *DBBean (A Integer reference to another Bean in another table)
* *List<DBBean> (A reference table is used to associate Beans into the list)
* </XMP>
* <ul>
* <li>Boolean</li>
* <li>Integer</li>
* <li>Short</li>
* <li>Float</li>
* <li>Double</li>
* <li>String</li>
* <li>Character</li>
* <li>java.sql.Timestamp</li>
* <li>DBBean (A Integer reference to another Bean in another table)</li>
* <li>List&lt;DBBean&gt; (A reference table is used to associate Beans into the list)</li>
* </ul>
* @author Ziver
*/
public abstract class DBBean {

6
src/zutil/image/ImageFilterProcessor.java
View file

@ -101,12 +101,12 @@ public abstract class ImageFilterProcessor {
}
/**
* Creates a Integer array with the pixel data of the image <XMP>
* Creates a Integer array with the pixel data of the image <pre>
* int[row][col][4]
* 0 -> Alpha data
* 0 -&gt; Alpha data
* Red data
* Green data
* 4 -> Blue data </XMP>
* 4 -&gt; Blue data </pre>
*
* @param img is the image to convert
* @param cols is the columns of the image

6
src/zutil/image/filter/DitheringFilter.java
View file

@ -49,12 +49,12 @@ public class DitheringFilter extends ImageFilterProcessor{
/**
* Creates a Dithering Effect object
* @param img The image to apply the effect on
* @param palette The palette to use on the image
* @param palette The palette to use on the image <pre>
* int[colorCount][4]
* 0 -> Alpha data
* 0 -&gt; Alpha data
* Red data
* Green data
* 4 -> Blue data
* 4 -&gt; Blue data </pre>
*/
public DitheringFilter(BufferedImage img, int[][] palette){
super(img);

2
src/zutil/ml/LinearRegression.java
View file

@ -16,7 +16,7 @@ public class LinearRegression {
* Method for calculating a hypothesis value fr a specific input value x.
* <br><br>
* <i>
* h(x) = theta0 * x0 + theta1 * x1 + ... + thetan * xn => transpose(theta) * x
* h(x) = theta0 * x0 + theta1 * x1 + ... + thetan * xn =&gt; transpose(theta) * x
* </i>
*/
protected static double[] calculateHypothesis(double[][] x, double[] theta){

2
src/zutil/net/http/HttpURL.java
View file

@ -103,7 +103,7 @@ public class HttpURL {
* Generates the parameter string in a URL.
*
* e.g.
* "key=value&key2=value&..."
* "key=value&amp;key2=value&amp;..."
*/
public String getParameterString(){
StringBuilder param = new StringBuilder();

4
src/zutil/parser/Templator.java
View file

@ -81,8 +81,8 @@ import java.util.logging.Logger;
* Comment, will be ignored.</li>
* </ul>
*
* TODO: {{> file}}: include file
* TODO: {{=<% %>=}}: change delimiter
* TODO: {{&gt; file}}: include file
* TODO: {{=&lt;% %&gt;=}}: change delimiter
*
* @author Ziver koc
*/

5
src/zutil/parser/json/JSONObjectInputStream.java
View file

@ -29,7 +29,6 @@ import zutil.log.LogUtil;
import zutil.parser.Base64Decoder;
import zutil.parser.DataNode;
import javax.activation.UnsupportedDataTypeException;
import java.io.*;
import java.lang.reflect.Array;
import java.lang.reflect.Field;
@ -123,7 +122,7 @@ public class JSONObjectInputStream extends InputStream implements ObjectInput, C
@SuppressWarnings({ "rawtypes", "unchecked" })
protected Object readType(Class<?> type, Class<?>[] genType, String key, DataNode json) throws IllegalAccessException, ClassNotFoundException, InstantiationException, UnsupportedDataTypeException, NoSuchFieldException {
protected Object readType(Class<?> type, Class<?>[] genType, String key, DataNode json) throws IllegalAccessException, ClassNotFoundException, InstantiationException, NoSuchFieldException {
if(json == null || type == null)
return null;
// Field type is a primitive?
@ -171,7 +170,7 @@ public class JSONObjectInputStream extends InputStream implements ObjectInput, C
}
protected Object readObject(Class<?> type, String key, DataNode json) throws IllegalAccessException, InstantiationException, ClassNotFoundException, IllegalArgumentException, UnsupportedDataTypeException, NoSuchFieldException {
protected Object readObject(Class<?> type, String key, DataNode json) throws IllegalAccessException, InstantiationException, ClassNotFoundException, IllegalArgumentException, NoSuchFieldException {
// Only parse if json is a map
if(json == null || !json.isMap())
return null;

5
src/zutil/parser/json/JSONObjectOutputStream.java
View file

@ -30,7 +30,6 @@ import zutil.parser.Base64Encoder;
import zutil.parser.DataNode;
import zutil.parser.DataNode.DataType;
import javax.activation.UnsupportedDataTypeException;
import java.io.*;
import java.lang.reflect.Array;
import java.lang.reflect.Field;
@ -169,7 +168,7 @@ public class JSONObjectOutputStream extends OutputStream implements ObjectOutput
return root;
}
private DataNode getPrimitiveDataNode(Class<?> type, Object value) throws UnsupportedDataTypeException, IllegalArgumentException {
private DataNode getPrimitiveDataNode(Class<?> type, Object value) throws IllegalArgumentException {
DataNode node;
if (type == int.class ||
type == Integer.class ||
@ -188,7 +187,7 @@ public class JSONObjectOutputStream extends OutputStream implements ObjectOutput
type == Character.class)
node = new DataNode(DataType.String);
else
throw new UnsupportedDataTypeException("Unsupported primitive data type: "+type.getName());
throw new IllegalArgumentException("Unsupported primitive data type: "+type.getName());
if(value != null)
node.set(value.toString());