Author: mkirby
Date: 2011-10-31 23:34:47 -0700 (Mon, 31 Oct 2011)
New Revision: 27353
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/AbstractFunction.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/ArgDescriptor.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/ArgType.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/BooleanList.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/CodeAndSourceLocation.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/DoubleList.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Equation.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/EquationCompiler.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/EquationParser.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/EquationUtil.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Function.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/FunctionError.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/FunctionUtil.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/IdentDescriptor.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Interpreter.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/LongList.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Node.java
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/StringList.java
Log:
Fixed Javadoc.
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/AbstractFunction.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/AbstractFunction.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/AbstractFunction.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -37,7 +37,9 @@
import java.util.TreeSet;
-/** Base class for all {@link Function} implementations. */
+/** Base class for all {@link Function} implementations.
+ * @CyAPI.Abstract.Class
+ */
public abstract class AbstractFunction implements Function {
final private ArgDescriptor[] argDescriptors;
@@ -119,6 +121,7 @@
}
/**
+ * Returns the static return type of this function.
* @return the static return type of this function, Object.class,
Double.cLass, String.class, or Boolean.class.
* If the static return type is Object.class, the dynamic
return type will be one of Double.cLass, String.class, or Boolean.class
* and will depend on the arguments passed to the function!
@@ -129,6 +132,7 @@
public abstract Class getReturnType();
/**
+ * Returns true of false if the args passed in had arity of a type
mismatch.
* @param argTypes the args to check for wrong arity or a type
mismatch.
* @return true or false if the args passed in had the wrong arity or a
type mismatch
*
@@ -164,6 +168,7 @@
}
/**
+ * Returns the return type of this function.
* @return the return type for this function (Double.class,
String.class, or Boolean.class)
* or null if the args passed in had the wrong arity or a
type mismatch
*
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/ArgDescriptor.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/ArgDescriptor.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/ArgDescriptor.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -34,8 +34,9 @@
import java.util.ArrayList;
-/**
+/** #ASKMIKE Needs method comments.
* A class describing a function argument.
+ * @CyAPI.Final.Class
*/
public final class ArgDescriptor {
private ArgType argType;
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/ArgType.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/ArgType.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/ArgType.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -36,6 +36,7 @@
/**
* An enum specifying a function argument type.
+ * @CyAPI.Enum.Class
*/
public enum ArgType {
// opt. mult.args. compatible
arg. types
@@ -135,8 +136,10 @@
this.acceptsMultipleArgs = acceptsMultipleArgs;
this.compatibleTypes = compatibleTypes;
}
-
+ /** #ASKMIKE */
public boolean isOptional() { return isOptional; }
+ /** #ASKMIKE */
public boolean acceptsMultipleArgs() { return acceptsMultipleArgs; }
+ /** #ASKMIKE */
public Class[] getCompatibleTypes() { return compatibleTypes; }
}
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/BooleanList.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/BooleanList.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/BooleanList.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -32,7 +32,10 @@
import java.util.ArrayList;
-
+/**
+ * #ASKMIKE
+ * @CyAPI.Final.Class
+ */
public final class BooleanList extends ArrayList<Boolean> {
public static final long serialVersionUID = -39245160342061982L;
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/CodeAndSourceLocation.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/CodeAndSourceLocation.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/CodeAndSourceLocation.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -32,6 +32,7 @@
/**
* Encapsulates compiled code with the location in the original source
equation.
+ * @CyAPI.Final.Class
*/
public final class CodeAndSourceLocation {
private final Object code;
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/DoubleList.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/DoubleList.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/DoubleList.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -32,7 +32,10 @@
import java.util.ArrayList;
-
+/**
+ * #ASKMIKE
+ * @CyAPI.Final.Class
+ */
public final class DoubleList extends ArrayList<Double> {
public static final long serialVersionUID = 9241560324069182L;
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Equation.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Equation.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Equation.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -34,7 +34,9 @@
import java.util.Map;
import java.util.Set;
-
+/** #ASKMIKE
+ * @CyAPI.Final.Class
+ */
public final class Equation {
private final String equation;
private final Set<String> variableReferences;
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/EquationCompiler.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/EquationCompiler.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/EquationCompiler.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -33,11 +33,14 @@
import java.util.Map;
-/** Compiler that compiles equations to byte (non-Java) code. */
+/** Compiler that compiles equations to byte (non-Java) code.
+ * @CyAPI.Api.Interface #ASKMIKE
+ */
public interface EquationCompiler {
/** Compiles a string to byte code plus some metadata as encapsulated
by the <code>Equation</code> class
* @param equation a textual representation of an
equation
* @param variableNameToTypeMap a mapping from variable names
occurring in "equation" to their respective types
+ * @return #ASKMIKE
*/
boolean compile(final String equation, final Map<String, Class<?>>
variableNameToTypeMap);
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/EquationParser.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/EquationParser.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/EquationParser.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -33,7 +33,9 @@
import java.util.Map;
import java.util.Set;
-
+/** #ASKMIKE
+ * @CyAPI.Api.Interface #ASKMIKE
+ */
public interface EquationParser {
/**
* After registering an attribute function "func" it can be used in
attribute equations.
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/EquationUtil.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/EquationUtil.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/EquationUtil.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -30,7 +30,9 @@
package org.cytoscape.equations;
-/** Various static utility methods relating to equations. **/
+/** Various static utility methods relating to equations.
+ * @CyAPI.Static.Class
+ */
public final class EquationUtil {
private EquationUtil() { } // Exists to prevent creating instances of
this class!
@@ -82,9 +84,10 @@
return true;
}
- /**
+ /** Returns "attribName" with characters that need to be
backslash-escaped when written as
+ * part of an attribute reference, escaped.
* @return "attribName" with characters that need to be
backslash-escaped when written as
- * part of an attribute refernce, escaped
+ * part of an attribute reference, escaped.
*/
private static String escapeAttribName(final String attribName) {
final int length = attribName.length();
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Function.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Function.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Function.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -32,7 +32,9 @@
import java.util.List;
-
+/** #ASKMIKE
+ * @CyAPI.Spi.Interface
+ */
public interface Function {
/**
* Used to parse the function string. This name is treated in a
case-insensitive manner!
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/FunctionError.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/FunctionError.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/FunctionError.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -29,7 +29,10 @@
*/
package org.cytoscape.equations;
-
+/**
+ * #ASKMIKE Needs method comments and class description.
+ * @CyAPI.Final.class
+ */
public final class FunctionError extends Exception {
private static final long serialVersionUID = 0xDAEDEBECFAEF2134L;
private final int argNumber; // Which argument this error is associated
with.
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/FunctionUtil.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/FunctionUtil.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/FunctionUtil.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -45,6 +45,7 @@
/**
* A collection of static methods that may be useful for the implementation
of built-in functions.
+ * @CyAPI.Static.Class
*/
public final class FunctionUtil {
private FunctionUtil() { } // Exists to prevent creating instances of
this class!
@@ -431,6 +432,7 @@
}
/**
+ * Returns "arg" converted to a Double, if possible, else null
* @return "arg" converted to a Double, if possible, else null
*/
static private Double convertToDouble(final Object arg) {
@@ -454,7 +456,8 @@
}
/**
- * @return "arg" converted to a Long, if possible, else null
+ * Returns "arg" converted to a Long, if possible, else null.
+ * @return "arg" converted to a Long, if possible, else null.
*/
static private Long convertToLong(final Object arg) {
if (arg.getClass() == Double.class)
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/IdentDescriptor.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/IdentDescriptor.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/IdentDescriptor.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -34,12 +34,13 @@
/** Used to hold a current value for an equation's variable reference.
+ * @CyAPI.Api.Interface #ASKMIKE
*/
public class IdentDescriptor {
private final Class type;
private final Object value;
- /** Initialises a new <code>IdentDescriptor</code> and provides minimal
type translation
+ /** Initializes a new <code>IdentDescriptor</code> and provides minimal
type translation
* (from <code>Integer</code> to <code>Long</code>).
* @param o an object that represents a value for a variable reference
* @throws NullPointerException if "o" is null
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Interpreter.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Interpreter.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Interpreter.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -32,7 +32,9 @@
import java.util.Map;
-
+/** #ASKMIKE
+ * @CyAPI.Api.Interface
+ */
public interface Interpreter {
/** Executes the code represented by "equation".
* @param equation compiled code and metadata
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/LongList.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/LongList.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/LongList.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -32,7 +32,10 @@
import java.util.ArrayList;
-
+/**
+ * #ASKMIKE
+ * @CyAPI.Final.Class
+ */
public final class LongList extends ArrayList<Long> {
public static final long serialVersionUID = -245160324069812L;
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Node.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Node.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/Node.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -35,6 +35,7 @@
/**
* A node in the parse tree.
+ * @CyAPI.Abstract.Class
*/
public abstract class Node {
private final int sourceLocation; // What location the "source code" is
this associated with.
Modified:
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/StringList.java
===================================================================
---
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/StringList.java
2011-11-01 00:05:47 UTC (rev 27352)
+++
core3/api/trunk/equations-api/src/main/java/org/cytoscape/equations/StringList.java
2011-11-01 06:34:47 UTC (rev 27353)
@@ -32,7 +32,10 @@
import java.util.ArrayList;
-
+/**
+ * #ASKMIKE
+ * @CyAPI.Final.Class
+ */
public final class StringList extends ArrayList<String> {
public static final long serialVersionUID = -4245160342069182L;
--
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en.
