You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2013/12/09 19:38:04 UTC
svn commit: r1549640 - in
/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima: examples/
jcas/cas/
Author: schor
Date: Mon Dec 9 18:38:04 2013
New Revision: 1549640
URL: http://svn.apache.org/r1549640
Log:
[UIMA-3484] javadoc fixes
Modified:
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/AnnotationBase.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray_Type.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray_Type.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/CommonArray_Type.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray_Type.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyFSList.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyFloatList.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyIntegerList.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyStringList.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray_Type.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSList.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatArray.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatArray_Type.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatList.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerArray.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerArray_Type.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerList.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray_Type.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyFSList.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyFloatList.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyIntegerList.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyStringList.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray_Type.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa_Type.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringArray.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringArray_Type.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringList.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/TOP.java
uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/TOP_Type.java
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/examples/SourceDocumentInformation.java Mon Dec 9 18:38:04 2013
@@ -60,7 +60,7 @@ public class SourceDocumentInformation e
protected SourceDocumentInformation() {
}
- /**
+ /*
* Internal - constructor used by generator
*
* @generated
@@ -95,7 +95,7 @@ public class SourceDocumentInformation e
// *--------------*
// * Feature: uri
- /**
+ /*
* getter for uri - gets URI of document. (For example, file:///MyDirectory/myFile.txt for a
* simple file or http://incubator.apache.org/uima/index.html for content from a web source.)
*
@@ -109,7 +109,7 @@ public class SourceDocumentInformation e
((SourceDocumentInformation_Type) jcasType).casFeatCode_uri);
}
- /**
+ /*
* setter for uri - sets URI of document. (For example, file:///MyDirectory/myFile.txt for a
* simple file or http://incubator.apache.org/uima/index.html for content from a web source.)
*
@@ -126,7 +126,7 @@ public class SourceDocumentInformation e
// *--------------*
// * Feature: offsetInSource
- /**
+ /*
* getter for offsetInSource - gets Byte offset of the start of document content within original
* source file or other input source. Only used if the CAS document was retrieved from an source
* where one physical source file contained several conceptual documents. Zero otherwise.
@@ -141,7 +141,7 @@ public class SourceDocumentInformation e
((SourceDocumentInformation_Type) jcasType).casFeatCode_offsetInSource);
}
- /**
+ /*
* setter for offsetInSource - sets Byte offset of the start of document content within original
* source file or other input source. Only used if the CAS document was retrieved from an source
* where one physical source file contained several conceptual documents. Zero otherwise.
@@ -159,7 +159,7 @@ public class SourceDocumentInformation e
// *--------------*
// * Feature: documentSize
- /**
+ /*
* getter for documentSize - gets Size of original document in bytes before processing by CAS
* Initializer. Either absolute file size of size within file or other source.
*
@@ -173,7 +173,7 @@ public class SourceDocumentInformation e
((SourceDocumentInformation_Type) jcasType).casFeatCode_documentSize);
}
- /**
+ /*
* setter for documentSize - sets Size of original document in bytes before processing by CAS
* Initializer. Either absolute file size of size within file or other source.
*
@@ -190,7 +190,7 @@ public class SourceDocumentInformation e
// *--------------*
// * Feature: lastSegment
- /**
+ /*
* getter for lastSegment - gets For a CAS that represents a segment of a larger source document,
* this flag indicates whether this CAS is the final segment of the source document. This is
* useful for downstream components that want to take some action after having seen all of the
@@ -206,7 +206,7 @@ public class SourceDocumentInformation e
((SourceDocumentInformation_Type) jcasType).casFeatCode_lastSegment);
}
- /**
+ /*
* setter for lastSegment - sets For a CAS that represents a segment of a larger source document,
* this flag indicates whether this CAS is the final segment of the source document. This is
* useful for downstream components that want to take some action after having seen all of the
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/AnnotationBase.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/AnnotationBase.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/AnnotationBase.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/AnnotationBase.java Mon Dec 9 18:38:04 2013
@@ -44,7 +44,7 @@ public class AnnotationBase extends org.
protected AnnotationBase() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public AnnotationBase(int addr, TOP_Type type) {
super(addr, type);
}
@@ -56,7 +56,7 @@ public class AnnotationBase extends org.
// *------------------*
// * Feature: sofa
// * Sofa reference of the annotation
- /**
+ /*
* getter for sofa - gets Sofaref for annotation
*/
public SofaFS getSofa() {
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray.java Mon Dec 9 18:38:04 2013
@@ -47,12 +47,16 @@ public final class BooleanArray extends
private BooleanArray() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public BooleanArray(int addr, TOP_Type type) {
super(addr, type);
}
- /** Make a new BooleanArray of given size */
+ /**
+ * Make a new BooleanArray of given size
+ * @param jcas JCas reference
+ * @param length of array
+ */
public BooleanArray(JCas jcas, int length) {
this(jcas.getLowLevelCas().ll_createBooleanArray(length), jcas.getType(typeIndexID));
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray_Type.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/BooleanArray_Type.java Mon Dec 9 18:38:04 2013
@@ -76,9 +76,11 @@ public final class BooleanArray_Type ext
// ******************************************************
/**
- * return the indexed value from the corresponding Cas StringArray as a Java String.
- *
* @see org.apache.uima.cas.BooleanArrayFS#get(int)
+ *
+ * @param addr low-level int reference to the boolean array to get the value from
+ * @param i index (in bits, 0 origin)
+ * @return the indexed value from the corresponding Cas StringArray as a Java String.
*/
public boolean get(int addr, int i) {
if (lowLevelTypeChecks)
@@ -89,9 +91,11 @@ public final class BooleanArray_Type ext
}
/**
- * updates the Cas, setting the indexed value to the passed in Java String value.
- *
* @see org.apache.uima.cas.BooleanArrayFS#set(int, boolean)
+ * updates the Cas, setting the indexed value to the value passed in.
+ * @param addr low-level int reference to the boolean array to set the value into
+ * @param i index (in bits, 0 origin)
+ * @param v the value to set
*/
public void set(int addr, int i, boolean v) {
if (lowLevelTypeChecks)
@@ -103,7 +107,14 @@ public final class BooleanArray_Type ext
/**
* @see org.apache.uima.cas.BooleanArrayFS#copyFromArray(boolean[], int, int, int)
+ *
+ * @param addr low-level int reference to the boolean array to set values into
+ * @param src a Java boolean array to copy from
+ * @param srcOffset the source offset
+ * @param destOffset the destination offset
+ * @param length the length (number of bits)
*/
+
public void copyFromArray(int addr, boolean[] src, int srcOffset, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
casImpl.checkArrayBounds(addr, destOffset, length);
@@ -114,6 +125,12 @@ public final class BooleanArray_Type ext
/**
* @see org.apache.uima.cas.BooleanArrayFS#copyToArray(int, boolean[], int, int)
+ *
+ * @param addr low-level int reference to the boolean array to get values from
+ * @param srcOffset the source offset
+ * @param dest the target to put boolean values into
+ * @param destOffset the destination offset
+ * @param length the length, in bits
*/
public void copyToArray(int addr, int srcOffset, boolean[] dest, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -125,6 +142,9 @@ public final class BooleanArray_Type ext
/**
* @see org.apache.uima.cas.BooleanArrayFS#toArray()
+ *
+ * @param addr low-level int reference to the boolean array
+ * @return a Java boolean array
*/
public boolean[] toArray(int addr) {
final int size = size(addr);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray.java Mon Dec 9 18:38:04 2013
@@ -47,12 +47,16 @@ public final class ByteArray extends TOP
private ByteArray() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public ByteArray(int addr, TOP_Type type) {
super(addr, type);
}
- /** Make a new ByteArray of given size */
+ /**
+ * Make a new ByteArray of given size
+ * @param jcas the JCas
+ * @param length the length of the array in bytes
+ */
public ByteArray(JCas jcas, int length) {
this(jcas.getLowLevelCas().ll_createByteArray(length), jcas.getType(typeIndexID));
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray_Type.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ByteArray_Type.java Mon Dec 9 18:38:04 2013
@@ -76,9 +76,11 @@ public final class ByteArray_Type extend
// ******************************************************
/**
- * return the indexed value from the corresponding Cas StringArray as a Java String.
- *
* @see org.apache.uima.cas.ByteArrayFS#get(int)
+ *
+ * @param addr low level CAS Feature Structure reference to get value from
+ * @param i the index
+ * @return the indexed value from the corresponding Cas ByesArray.
*/
public byte get(int addr, int i) {
if (lowLevelTypeChecks)
@@ -89,9 +91,11 @@ public final class ByteArray_Type extend
}
/**
- * updates the Cas, setting the indexed value to the passed in Java String value.
- *
+ * updates the Cas, setting the indexed value to the passed in Java value
* @see org.apache.uima.cas.ByteArrayFS#set(int, byte)
+ * @param addr low level CAS Feature Structure reference to set value into
+ * @param i the index
+ * @param v the value
*/
public void set(int addr, int i, byte v) {
if (lowLevelTypeChecks)
@@ -103,6 +107,12 @@ public final class ByteArray_Type extend
/**
* @see org.apache.uima.cas.ByteArrayFS#copyFromArray(byte[], int, int, int)
+ *
+ * @param addr low level reference to the FS in the CAS
+ * @param src where to copy data from
+ * @param srcOffset the source offset
+ * @param destOffset the destination offset
+ * @param length the number of bytes to copy
*/
public void copyFromArray(int addr, byte[] src, int srcOffset, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -114,6 +124,12 @@ public final class ByteArray_Type extend
/**
* @see org.apache.uima.cas.ByteArrayFS#copyToArray(int, byte[], int, int)
+ *
+ * @param addr low level reference to the FS in the CAS
+ * @param srcOffset the source offset
+ * @param dest the array to copy into
+ * @param destOffset the destination offset
+ * @param length the number of bytes to copy
*/
public void copyToArray(int addr, int srcOffset, byte[] dest, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -125,6 +141,9 @@ public final class ByteArray_Type extend
/**
* @see org.apache.uima.cas.ByteArrayFS#toArray()
+ *
+ * @param addr low level reference to the FS in the CAS
+ * @return a copy of the byte array as a Java object
*/
public byte[] toArray(int addr) {
final int size = size(addr);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/CommonArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/CommonArray_Type.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/CommonArray_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/CommonArray_Type.java Mon Dec 9 18:38:04 2013
@@ -42,7 +42,10 @@ public class CommonArray_Type extends TO
* public int noObjCreate(int length) { casImpl.checkArrayPreconditions(length); return
* casImpl.createTempArray(casTypeCode, length); }
*/
- /** return the size of the array */
+ /**
+ * @param addr the low level reference to the array in the CAS
+ * @return the size of the array
+ */
public int size(int addr) {
return casImpl.ll_getArraySize(addr);
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray.java Mon Dec 9 18:38:04 2013
@@ -47,12 +47,16 @@ public final class DoubleArray extends T
private DoubleArray() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public DoubleArray(int addr, TOP_Type type) {
super(addr, type);
}
- /** Make a new DoubleArray of given size */
+ /**
+ * Make a new DoubleArray of given size
+ * @param jcas The JCas
+ * @param length the length of the array
+ */
public DoubleArray(JCas jcas, int length) {
this(jcas.getLowLevelCas().ll_createDoubleArray(length), jcas.getType(typeIndexID));
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray_Type.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/DoubleArray_Type.java Mon Dec 9 18:38:04 2013
@@ -76,9 +76,10 @@ public final class DoubleArray_Type exte
// ******************************************************
/**
- * return the indexed value from the corresponding Cas StringArray as a Java String.
- *
- * @see org.apache.uima.cas.DoubleArrayFS#get(int)
+ * return the indexed value from the corresponding Cas DoubleArray as a Java double.
+ * @param addr low level CAS FS reference
+ * @param i the index
+ * @return the value
*/
public double get(int addr, int i) {
if (lowLevelTypeChecks)
@@ -89,9 +90,11 @@ public final class DoubleArray_Type exte
}
/**
- * updates the Cas, setting the indexed value to the passed in Java String value.
- *
+ * updates the Cas, setting the indexed value to the passed in Java double value.
* @see org.apache.uima.cas.DoubleArrayFS#set(int, double)
+ * @param addr low level CAS FS reference
+ * @param i the index
+ * @param v the value
*/
public void set(int addr, int i, double v) {
if (lowLevelTypeChecks)
@@ -103,6 +106,11 @@ public final class DoubleArray_Type exte
/**
* @see org.apache.uima.cas.DoubleArrayFS#copyFromArray(double[], int, int, int)
+ * @param addr low level CAS Feature Structure reference for the destination
+ * @param src the source array to copy from
+ * @param srcOffset the source offset
+ * @param destOffset the destination offset
+ * @param length the number of items to copy
*/
public void copyFromArray(int addr, double[] src, int srcOffset, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -114,6 +122,11 @@ public final class DoubleArray_Type exte
/**
* @see org.apache.uima.cas.DoubleArrayFS#copyToArray(int, double[], int, int)
+ * @param addr the low level CAS Feature Structure reference for the source
+ * @param srcOffset the source offset
+ * @param dest the destination to copy into
+ * @param destOffset the destination offset
+ * @param length the number of items to copy
*/
public void copyToArray(int addr, int srcOffset, double[] dest, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -125,6 +138,8 @@ public final class DoubleArray_Type exte
/**
* @see org.apache.uima.cas.DoubleArrayFS#toArray()
+ * @param addr the low level CAS Feature Structure reference to copy from
+ * @return a Java object which is a copy of the values in the array
*/
public double[] toArray(int addr) {
final int size = size(addr);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyFSList.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyFSList.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyFSList.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyFSList.java Mon Dec 9 18:38:04 2013
@@ -36,7 +36,7 @@ public class EmptyFSList extends FSList
protected EmptyFSList() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public EmptyFSList(int addr, TOP_Type type) {
super(addr, type);
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyFloatList.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyFloatList.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyFloatList.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyFloatList.java Mon Dec 9 18:38:04 2013
@@ -36,7 +36,7 @@ public class EmptyFloatList extends Floa
protected EmptyFloatList() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public EmptyFloatList(int addr, TOP_Type type) {
super(addr, type);
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyIntegerList.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyIntegerList.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyIntegerList.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyIntegerList.java Mon Dec 9 18:38:04 2013
@@ -36,7 +36,7 @@ public class EmptyIntegerList extends In
protected EmptyIntegerList() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public EmptyIntegerList(int addr, TOP_Type type) {
super(addr, type);
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyStringList.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyStringList.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyStringList.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/EmptyStringList.java Mon Dec 9 18:38:04 2013
@@ -36,7 +36,7 @@ public class EmptyStringList extends Str
protected EmptyStringList() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public EmptyStringList(int addr, TOP_Type type) {
super(addr, type);
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray.java Mon Dec 9 18:38:04 2013
@@ -51,12 +51,16 @@ public final class FSArray extends TOP i
private FSArray() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public FSArray(int addr, TOP_Type type) {
super(addr, type);
}
- /** Make a new FSArray of given size */
+ /**
+ * Make a new FSArray of given size
+ * @param jcas The JCas
+ * @param length The number of elements in the new array
+ */
public FSArray(JCas jcas, int length) {
this(
/* addr */jcas.getLowLevelCas().ll_createArray(jcas.getType(typeIndexID).casTypeCode, length),
@@ -150,8 +154,8 @@ public final class FSArray extends TOP i
* The number of elements to copy.
* @exception ArrayIndexOutOfBoundsException
* If <code>srcOffset < 0</code> or
- * <code>length > size()</code> or
- * <code>destOffset + length > destArray.length</code>.
+ * <code>length > size()</code> or
+ * <code>destOffset + length > destArray.length</code>.
*/
public void copyToArray(int srcOffset, String[] dest, int destOffset, int length) {
CASImpl ll = jcasType.casImpl;
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray_Type.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSArray_Type.java Mon Dec 9 18:38:04 2013
@@ -76,9 +76,11 @@ public class FSArray_Type extends Common
// ******************************************************
/**
- * return the indexed value from the corresponding Cas FSArray as a JCas object.
- *
* @see org.apache.uima.cas.ArrayFS#get(int)
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @param i the index
+ * @return the indexed value from the corresponding Cas FSArray as a JCas object.
*/
public FeatureStructure get(int addr, int i) {
if (lowLevelTypeChecks)
@@ -92,6 +94,10 @@ public class FSArray_Type extends Common
* updates the Cas, setting the indexed value to the passed in FeatureStructure value.
*
* @see org.apache.uima.cas.ArrayFS#set(int, FeatureStructure)
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @param i the index
+ * @param v the value
*/
public void set(int addr, int i, FeatureStructure v) {
if (lowLevelTypeChecks)
@@ -103,6 +109,13 @@ public class FSArray_Type extends Common
/**
* @see org.apache.uima.cas.ArrayFS#copyFromArray(FeatureStructure[], int, int, int)
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @param src the Java array object to copy from
+ * @param srcOffset the source offset
+ * @param destOffset the destination offset
+ * @param length the number of items to copy
+ * @throws ArrayIndexOutOfBoundsException if index out of bounds
*/
public void copyFromArray(int addr, FeatureStructure[] src, int srcOffset, int destOffset,
int length) throws ArrayIndexOutOfBoundsException {
@@ -117,9 +130,16 @@ public class FSArray_Type extends Common
++srcOffset;
}
}
-
+
/**
* @see org.apache.uima.cas.ArrayFS#copyToArray(int, FeatureStructure[], int, int)
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @param srcOffset the CAS source offset
+ * @param dest the Java object to copy into
+ * @param destOffset the destination offset
+ * @param length the number of items to copy
+ * @throws ArrayIndexOutOfBoundsException if index out of bounds
*/
public void copyToArray(int addr, int srcOffset, FeatureStructure[] dest, int destOffset,
int length) throws ArrayIndexOutOfBoundsException {
@@ -137,6 +157,9 @@ public class FSArray_Type extends Common
/**
* @see org.apache.uima.cas.ArrayFS#toArray()
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @return a copy of the CAS array as a Java object
*/
public FeatureStructure[] toArray(int addr) {
final int size = size(addr);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSList.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSList.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSList.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FSList.java Mon Dec 9 18:38:04 2013
@@ -37,7 +37,7 @@ public class FSList extends org.apache.u
protected FSList() {// Disable default constructor
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public FSList(int addr, TOP_Type type) {
super(addr, type);
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatArray.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatArray.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatArray.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatArray.java Mon Dec 9 18:38:04 2013
@@ -51,12 +51,16 @@ public final class FloatArray extends TO
// * 1 - create via factory.create() a new one
// * 2 - iterator or dereferencing calling generator to create
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public FloatArray(int addr, TOP_Type type) {
super(addr, type);
}
- /** Make a new FloatArray of given size */
+ /**
+ * Make a new FloatArray of given size
+ * @param jcas the JCas
+ * @param length the size of the array
+ */
public FloatArray(JCas jcas, int length) {
this(
/* addr */
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatArray_Type.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatArray_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatArray_Type.java Mon Dec 9 18:38:04 2013
@@ -76,9 +76,11 @@ public class FloatArray_Type extends Com
// ******************************************************
/**
- * return the indexed value from the corresponding Cas floatArray as a Java float.
- *
* @see org.apache.uima.cas.ArrayFS#get(int)
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @param i the index
+ * @return the indexed value from the corresponding Cas floatArray as a Java float.
*/
public float get(int addr, int i) {
if (lowLevelTypeChecks)
@@ -90,19 +92,28 @@ public class FloatArray_Type extends Com
/**
* updates the Cas, setting the indexed value to the passed in Java float value.
- *
* @see org.apache.uima.cas.ArrayFS#set(int, FeatureStructure)
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @param i the index
+ * @param value the value to set
*/
- public void set(int addr, int i, float str) {
+ public void set(int addr, int i, float value) {
if (lowLevelTypeChecks)
- ll_cas.ll_setFloatArrayValue(addr, i, str, true);
+ ll_cas.ll_setFloatArrayValue(addr, i, value, true);
if (lowLevelArrayBoundChecks)
casImpl.checkArrayBounds(addr, i);
- ll_cas.ll_setFloatArrayValue(addr, i, str);
+ ll_cas.ll_setFloatArrayValue(addr, i, value);
}
/**
* @see org.apache.uima.cas.FloatArrayFS#copyFromArray(float[], int, int, int)
+ *
+ * @param addr the low level CAS Feature Structure reference to copy into
+ * @param src the array to copy from
+ * @param srcOffset the source offset
+ * @param destOffset the destination offset
+ * @param length the number of items to copy
*/
public void copyFromArray(int addr, float[] src, int srcOffset, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -111,9 +122,13 @@ public class FloatArray_Type extends Com
ll_cas.ll_setFloatArrayValue(addr, i + destOffset, src[i + srcOffset]);
}
}
-
/**
- * @see org.apache.uima.cas.FloatArrayFS#copyToArray(int, float[], int, int)
+ *
+ * @param addr the low level CAS Feature Structure reference to copy from
+ * @param srcOffset the source offset
+ * @param dest the target to copy into
+ * @param destOffset the destination offset
+ * @param length the number of items to copy
*/
public void copyToArray(int addr, int srcOffset, float[] dest, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -125,6 +140,9 @@ public class FloatArray_Type extends Com
/**
* @see org.apache.uima.cas.FloatArrayFS#toArray()
+ *
+ * @param addr the low level CAS Feature Structure reference to copy from
+ * @return a copy of the array
*/
public float[] toArray(int addr) {
final int size = size(addr);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatList.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatList.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatList.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/FloatList.java Mon Dec 9 18:38:04 2013
@@ -37,7 +37,7 @@ public class FloatList extends org.apach
protected FloatList() {// Disable default constructor
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public FloatList(int addr, TOP_Type type) {
super(addr, type);
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerArray.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerArray.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerArray.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerArray.java Mon Dec 9 18:38:04 2013
@@ -46,12 +46,16 @@ public final class IntegerArray extends
private IntegerArray() { // never called. Here to disable default constructor
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public IntegerArray(int addr, TOP_Type type) {
super(addr, type);
}
- /** Make a new IntegerArray of given size */
+ /**
+ * Make a new IntegerArray of given size
+ * @param jcas The JCas
+ * @param length The number of elements in the new array
+ */
public IntegerArray(JCas jcas, int length) {
this(
/* addr */jcas.getLowLevelCas().ll_createArray(jcas.getType(typeIndexID).casTypeCode, length),
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerArray_Type.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerArray_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerArray_Type.java Mon Dec 9 18:38:04 2013
@@ -79,9 +79,11 @@ public class IntegerArray_Type extends C
// ******************************************************
/**
- * return the indexed value from the corresponding Cas StringArray as a Java String.
- *
* @see org.apache.uima.cas.IntArrayFS#get(int)
+ *
+ * @param addr low level CAS Feature Structure reference
+ * @param i the index
+ * @return the indexed value from the corresponding Cas IntegerArray
*/
public int get(int addr, int i) {
if (lowLevelTypeChecks)
@@ -92,9 +94,12 @@ public class IntegerArray_Type extends C
}
/**
- * updates the Cas, setting the indexed value to the passed in Java String value.
- *
+ * updates the Cas from the passed in Java value.
* @see org.apache.uima.cas.IntArrayFS#set(int, int)
+ *
+ * @param addr low level CAS Feature Structure reference
+ * @param i the index
+ * @param v the value
*/
public void set(int addr, int i, int v) {
if (lowLevelTypeChecks)
@@ -106,6 +111,12 @@ public class IntegerArray_Type extends C
/**
* @see org.apache.uima.cas.IntArrayFS#copyFromArray(int[], int, int, int)
+ *
+ * @param addr low level CAS Feature Structure reference
+ * @param src the source (Java object) to copy from
+ * @param srcOffset the source offset
+ * @param destOffset the destination (the CAS Feature Structure) offset
+ * @param length number of items to copy
*/
public void copyFromArray(int addr, int[] src, int srcOffset, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -117,6 +128,12 @@ public class IntegerArray_Type extends C
/**
* @see org.apache.uima.cas.IntArrayFS#copyToArray(int, int[], int, int)
+ *
+ * @param addr low level CAS Feature Structure reference
+ * @param srcOffset The CAS source offset
+ * @param dest the Java object to copy into
+ * @param destOffset the destination offset
+ * @param length number of items to copy
*/
public void copyToArray(int addr, int srcOffset, int[] dest, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -128,6 +145,9 @@ public class IntegerArray_Type extends C
/**
* @see org.apache.uima.cas.IntArrayFS#toArray()
+ *
+ * @param addr low level CAS Feature Structure reference
+ * @return a copy of the CAS array as a Java object
*/
public int[] toArray(int addr) {
final int size = size(addr);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerList.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerList.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerList.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/IntegerList.java Mon Dec 9 18:38:04 2013
@@ -37,7 +37,7 @@ public class IntegerList extends org.apa
protected IntegerList() { // Disable default constructor
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public IntegerList(int addr, TOP_Type type) {
super(addr, type);
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray.java Mon Dec 9 18:38:04 2013
@@ -47,12 +47,16 @@ public final class LongArray extends TOP
private LongArray() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public LongArray(int addr, TOP_Type type) {
super(addr, type);
}
- /** Make a new LongArray of given size */
+ /**
+ * Make a new LongArray of given size
+ * @param jcas The JCas
+ * @param length The number of elements in the new array
+ */
public LongArray(JCas jcas, int length) {
this(jcas.getLowLevelCas().ll_createLongArray(length), jcas.getType(typeIndexID));
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray_Type.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/LongArray_Type.java Mon Dec 9 18:38:04 2013
@@ -76,9 +76,11 @@ public final class LongArray_Type extend
// ******************************************************
/**
- * return the indexed value from the corresponding Cas StringArray as a Java String.
- *
* @see org.apache.uima.cas.LongArrayFS#get(int)
+ *
+ * @param addr low level CAS Feature Structure reference
+ * @param i the index
+ * @return the indexed value from the corresponding Cas LongArray as a Java long.
*/
public long get(int addr, int i) {
if (lowLevelTypeChecks)
@@ -88,11 +90,14 @@ public final class LongArray_Type extend
return ll_cas.ll_getLongArrayValue(addr, i);
}
- /**
- * updates the Cas, setting the indexed value to the passed in Java String value.
- *
+ /**
+ * updates the Cas, setting the indexed value to the passed in Java long.
* @see org.apache.uima.cas.LongArrayFS#set(int, long)
- */
+ *
+ * @param addr low level CAS Feature Structure reference
+ * @param i the index
+ * @param v the value to set
+ */
public void set(int addr, int i, long v) {
if (lowLevelTypeChecks)
ll_cas.ll_setLongArrayValue(addr, i, v, true);
@@ -103,6 +108,12 @@ public final class LongArray_Type extend
/**
* @see org.apache.uima.cas.LongArrayFS#copyFromArray(long[], int, int, int)
+ *
+ * @param addr low level CAS Feature Structure reference
+ * @param src the Java object to coyp from
+ * @param srcOffset the source offset
+ * @param destOffset the destination (in the CAS) offset
+ * @param length the number of items to copy
*/
public void copyFromArray(int addr, long[] src, int srcOffset, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -114,6 +125,12 @@ public final class LongArray_Type extend
/**
* @see org.apache.uima.cas.LongArrayFS#copyToArray(int, long[], int, int)
+ *
+ * @param addr low level CAS Feature Structure reference
+ * @param srcOffset the source offset in the CAS
+ * @param dest the Java object to copy into
+ * @param destOffset the destination offset
+ * @param length the number of items to copy
*/
public void copyToArray(int addr, int srcOffset, long[] dest, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -125,6 +142,9 @@ public final class LongArray_Type extend
/**
* @see org.apache.uima.cas.LongArrayFS#toArray()
+ *
+ * @param addr low level CAS Feature Structure reference
+ * @return a copy of the CAS Object as a Java object
*/
public long[] toArray(int addr) {
final int size = size(addr);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyFSList.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyFSList.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyFSList.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyFSList.java Mon Dec 9 18:38:04 2013
@@ -36,7 +36,7 @@ public class NonEmptyFSList extends FSLi
protected NonEmptyFSList() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public NonEmptyFSList(int addr, TOP_Type type) {
super(addr, type);
}
@@ -47,7 +47,7 @@ public class NonEmptyFSList extends FSLi
// *------------------*
// * Feature: head
- /** getter for head * */
+ /* getter for head * */
public org.apache.uima.jcas.cas.TOP getHead() {
if (NonEmptyFSList_Type.featOkTst && ((NonEmptyFSList_Type) jcasType).casFeat_head == null)
this.jcasType.jcas.throwFeatMissing("head", "uima.cas.NonEmptyFSList");
@@ -55,7 +55,7 @@ public class NonEmptyFSList extends FSLi
.ll_getRefValue(addr, ((NonEmptyFSList_Type) jcasType).casFeatCode_head)));
}
- /** setter for head * */
+ /* setter for head * */
public void setHead(org.apache.uima.jcas.cas.TOP v) {
if (NonEmptyFSList_Type.featOkTst && ((NonEmptyFSList_Type) jcasType).casFeat_head == null)
this.jcasType.jcas.throwFeatMissing("head", "uima.cas.NonEmptyFSList");
@@ -65,7 +65,7 @@ public class NonEmptyFSList extends FSLi
// *------------------*
// * Feature: tail
- /** getter for tail * */
+ /* getter for tail * */
public FSList getTail() {
if (NonEmptyFSList_Type.featOkTst && ((NonEmptyFSList_Type) jcasType).casFeat_tail == null)
this.jcasType.jcas.throwFeatMissing("tail", "uima.cas.NonEmptyFSList");
@@ -73,7 +73,7 @@ public class NonEmptyFSList extends FSLi
((NonEmptyFSList_Type) jcasType).casFeatCode_tail)));
}
- /** setter for tail * */
+ /* setter for tail * */
public void setTail(FSList v) {
if (NonEmptyFSList_Type.featOkTst && ((NonEmptyFSList_Type) jcasType).casFeat_tail == null)
this.jcasType.jcas.throwFeatMissing("tail", "uima.cas.NonEmptyFSList");
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyFloatList.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyFloatList.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyFloatList.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyFloatList.java Mon Dec 9 18:38:04 2013
@@ -36,7 +36,7 @@ public class NonEmptyFloatList extends F
protected NonEmptyFloatList() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public NonEmptyFloatList(int addr, TOP_Type type) {
super(addr, type);
}
@@ -47,7 +47,7 @@ public class NonEmptyFloatList extends F
// *------------------*
// * Feature: head
- /** getter for head * */
+ /* getter for head * */
public float getHead() {
if (NonEmptyFloatList_Type.featOkTst
&& ((NonEmptyFloatList_Type) jcasType).casFeat_head == null)
@@ -56,7 +56,7 @@ public class NonEmptyFloatList extends F
((NonEmptyFloatList_Type) jcasType).casFeatCode_head);
}
- /** setter for head * */
+ /* setter for head * */
public void setHead(float v) {
if (NonEmptyFloatList_Type.featOkTst
&& ((NonEmptyFloatList_Type) jcasType).casFeat_head == null)
@@ -66,7 +66,7 @@ public class NonEmptyFloatList extends F
// *------------------*
// * Feature: tail
- /** getter for tail * */
+ /* getter for tail * */
public FloatList getTail() {
if (NonEmptyFloatList_Type.featOkTst
&& ((NonEmptyFloatList_Type) jcasType).casFeat_tail == null)
@@ -75,7 +75,7 @@ public class NonEmptyFloatList extends F
((NonEmptyFloatList_Type) jcasType).casFeatCode_tail)));
}
- /** setter for tail * */
+ /* setter for tail * */
public void setTail(FloatList v) {
if (NonEmptyFloatList_Type.featOkTst
&& ((NonEmptyFloatList_Type) jcasType).casFeat_tail == null)
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyIntegerList.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyIntegerList.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyIntegerList.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyIntegerList.java Mon Dec 9 18:38:04 2013
@@ -36,7 +36,7 @@ public class NonEmptyIntegerList extends
protected NonEmptyIntegerList() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public NonEmptyIntegerList(int addr, TOP_Type type) {
super(addr, type);
}
@@ -47,7 +47,7 @@ public class NonEmptyIntegerList extends
// *------------------*
// * Feature: head
- /** getter for head * */
+ /* getter for head * */
public int getHead() {
if (NonEmptyIntegerList_Type.featOkTst
&& ((NonEmptyIntegerList_Type) jcasType).casFeat_head == null)
@@ -56,7 +56,7 @@ public class NonEmptyIntegerList extends
((NonEmptyIntegerList_Type) jcasType).casFeatCode_head);
}
- /** setter for head * */
+ /* setter for head * */
public void setHead(int v) {
if (NonEmptyIntegerList_Type.featOkTst
&& ((NonEmptyIntegerList_Type) jcasType).casFeat_head == null)
@@ -66,7 +66,7 @@ public class NonEmptyIntegerList extends
// *------------------*
// * Feature: tail
- /** getter for tail * */
+ /* getter for tail * */
public IntegerList getTail() {
if (NonEmptyIntegerList_Type.featOkTst
&& ((NonEmptyIntegerList_Type) jcasType).casFeat_tail == null)
@@ -75,7 +75,7 @@ public class NonEmptyIntegerList extends
((NonEmptyIntegerList_Type) jcasType).casFeatCode_tail)));
}
- /** setter for tail * */
+ /* setter for tail * */
public void setTail(IntegerList v) {
if (NonEmptyIntegerList_Type.featOkTst
&& ((NonEmptyIntegerList_Type) jcasType).casFeat_tail == null)
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyStringList.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyStringList.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyStringList.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/NonEmptyStringList.java Mon Dec 9 18:38:04 2013
@@ -36,7 +36,7 @@ public class NonEmptyStringList extends
protected NonEmptyStringList() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public NonEmptyStringList(int addr, TOP_Type type) {
super(addr, type);
}
@@ -47,7 +47,7 @@ public class NonEmptyStringList extends
// *------------------*
// * Feature: head
- /** getter for head * */
+ /* getter for head * */
public String getHead() {
if (NonEmptyStringList_Type.featOkTst
&& ((NonEmptyStringList_Type) jcasType).casFeat_head == null)
@@ -56,7 +56,7 @@ public class NonEmptyStringList extends
((NonEmptyStringList_Type) jcasType).casFeatCode_head);
}
- /** setter for head * */
+ /* setter for head * */
public void setHead(String v) {
if (NonEmptyStringList_Type.featOkTst
&& ((NonEmptyStringList_Type) jcasType).casFeat_head == null)
@@ -67,7 +67,7 @@ public class NonEmptyStringList extends
// *------------------*
// * Feature: tail
- /** getter for tail * */
+ /* getter for tail * */
public StringList getTail() {
if (NonEmptyStringList_Type.featOkTst
&& ((NonEmptyStringList_Type) jcasType).casFeat_tail == null)
@@ -76,7 +76,7 @@ public class NonEmptyStringList extends
((NonEmptyStringList_Type) jcasType).casFeatCode_tail)));
}
- /** setter for tail * */
+ /* setter for tail * */
public void setTail(StringList v) {
if (NonEmptyStringList_Type.featOkTst
&& ((NonEmptyStringList_Type) jcasType).casFeat_tail == null)
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray.java Mon Dec 9 18:38:04 2013
@@ -47,12 +47,16 @@ public final class ShortArray extends TO
private ShortArray() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public ShortArray(int addr, TOP_Type type) {
super(addr, type);
}
- /** Make a new ShortArray of given size */
+ /**
+ * Make a new ShortArray of given size
+ * @param jcas The JCas
+ * @param length The number of elements in the new array
+ */
public ShortArray(JCas jcas, int length) {
this(jcas.getLowLevelCas().ll_createShortArray(length), jcas.getType(typeIndexID));
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray_Type.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/ShortArray_Type.java Mon Dec 9 18:38:04 2013
@@ -76,9 +76,11 @@ public final class ShortArray_Type exten
// ******************************************************
/**
- * return the indexed value from the corresponding Cas StringArray as a Java String.
- *
* @see org.apache.uima.cas.ShortArrayFS#get(int)
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @param i the index
+ * @return the indexed value from the corresponding Cas Feature Structure
*/
public short get(int addr, int i) {
if (lowLevelTypeChecks)
@@ -90,9 +92,13 @@ public final class ShortArray_Type exten
/**
* updates the Cas, setting the indexed value to the passed in Java String value.
- *
* @see org.apache.uima.cas.ShortArrayFS#set(int, short)
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @param i the index
+ * @param v the value
*/
+
public void set(int addr, int i, short v) {
if (lowLevelTypeChecks)
ll_cas.ll_setShortArrayValue(addr, i, v, true);
@@ -103,6 +109,12 @@ public final class ShortArray_Type exten
/**
* @see org.apache.uima.cas.ShortArrayFS#copyFromArray(short[], int, int, int)
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @param src the Java object used as the source
+ * @param srcOffset the source offset
+ * @param destOffset the destination (in the CAS FS) offset
+ * @param length the number of items to copy
*/
public void copyFromArray(int addr, short[] src, int srcOffset, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -114,6 +126,12 @@ public final class ShortArray_Type exten
/**
* @see org.apache.uima.cas.ShortArrayFS#copyToArray(int, short[], int, int)
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @param srcOffset the source offset
+ * @param dest the Java object to copy into
+ * @param destOffset the destination offset
+ * @param length the number of items to copy
*/
public void copyToArray(int addr, int srcOffset, short[] dest, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -125,6 +143,9 @@ public final class ShortArray_Type exten
/**
* @see org.apache.uima.cas.ShortArrayFS#toArray()
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @return a copy of the CAS Feature Structure Array as a Java Object
*/
public short[] toArray(int addr) {
final int size = size(addr);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa.java Mon Dec 9 18:38:04 2013
@@ -62,7 +62,7 @@ public class Sofa extends TOP implements
protected Sofa() {
}
- /**
+ /*
* Internal - constructor used by generator
*
* @generated
@@ -73,9 +73,15 @@ public class Sofa extends TOP implements
}
/**
+ *
+ * @param jcas JCas
+ * @param ID the sofa ID
+ * @param mimeType the mime type
+ *
* @deprecated As of v2.0, use {@link JCasImpl#createView(String)} to create a view, which will
* also create the Sofa for that view.
- */
+
+ */
@Deprecated
public Sofa(JCas jcas, SofaID ID, String mimeType) {
super(jcas);
@@ -96,7 +102,7 @@ public class Sofa extends TOP implements
// *--------------*
// * Feature: sofaNum
// ** Note: this gets the same feature, sofaNum, as getSofaRef, below
- /**
+ /*
* getter for sofaNum - gets
*
* @generated
@@ -110,7 +116,7 @@ public class Sofa extends TOP implements
// *--------------*
// * Feature: sofaID
- /**
+ /*
* getter for sofaID - gets
*
* @generated
@@ -124,7 +130,7 @@ public class Sofa extends TOP implements
// *--------------*
// * Feature: mimeType
- /**
+ /*
* getter for mimeType - gets
*
* @generated
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa_Type.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/Sofa_Type.java Mon Dec 9 18:38:04 2013
@@ -84,7 +84,7 @@ public class Sofa_Type extends TOP_Type
/** @generated */
final int casFeatCode_mimeType;
- /**
+ /*
* initialize variables to correspond with Cas Type and Features
*
* @generated
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringArray.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringArray.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringArray.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringArray.java Mon Dec 9 18:38:04 2013
@@ -47,12 +47,16 @@ public final class StringArray extends T
private StringArray() {
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public StringArray(int addr, TOP_Type type) {
super(addr, type);
}
- /** Make a new StringArray of given size */
+ /**
+ * Make a new StringArray of given size
+ * @param jcas The JCas
+ * @param length The number of elements in the new array
+ */
public StringArray(JCas jcas, int length) {
this(
/* addr */jcas.getLowLevelCas().ll_createArray(jcas.getType(typeIndexID).casTypeCode, length,
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringArray_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringArray_Type.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringArray_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringArray_Type.java Mon Dec 9 18:38:04 2013
@@ -77,9 +77,11 @@ public final class StringArray_Type exte
// ******************************************************
/**
- * return the indexed value from the corresponding Cas StringArray as a Java String.
- *
* @see org.apache.uima.cas.StringArrayFS#get(int)
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @param i the index
+ * @return the indexed value from the corresponding Cas StringArray as a Java String.
*/
public String get(int addr, int i) {
if (lowLevelTypeChecks)
@@ -93,6 +95,10 @@ public final class StringArray_Type exte
* updates the Cas, setting the indexed value to the passed in Java String value.
*
* @see org.apache.uima.cas.StringArrayFS#set(int, String)
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @param i the index
+ * @param v the value
*/
public void set(int addr, int i, String v) {
if (lowLevelTypeChecks)
@@ -104,6 +110,12 @@ public final class StringArray_Type exte
/**
* @see org.apache.uima.cas.StringArrayFS#copyFromArray(String[], int, int, int)
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @param src the Java object source
+ * @param srcOffset the source offset
+ * @param destOffset the destination offset in the CAS Feature Structure
+ * @param length the number of items to copy
*/
public void copyFromArray(int addr, String[] src, int srcOffset, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -115,6 +127,12 @@ public final class StringArray_Type exte
/**
* @see org.apache.uima.cas.StringArrayFS#copyToArray(int, String[], int, int)
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @param srcOffset the offset in the CAS Feature Structure
+ * @param dest the Java object destination
+ * @param destOffset the destination offset
+ * @param length the number of items to copy
*/
public void copyToArray(int addr, int srcOffset, String[] dest, int destOffset, int length) {
if (lowLevelArrayBoundChecks)
@@ -126,6 +144,9 @@ public final class StringArray_Type exte
/**
* @see org.apache.uima.cas.StringArrayFS#toArray()
+ *
+ * @param addr the low level CAS Feature Structure reference
+ * @return a copy of the string array
*/
public String[] toArray(int addr) {
final int size = size(addr);
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringList.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringList.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringList.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/StringList.java Mon Dec 9 18:38:04 2013
@@ -37,7 +37,7 @@ public class StringList extends org.apac
protected StringList() { // Disable default constructor
}
- /** Internal - Constructor used by generator */
+ /* Internal - Constructor used by generator */
public StringList(int addr, TOP_Type type) {
super(addr, type);
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/TOP.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/TOP.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/TOP.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/TOP.java Mon Dec 9 18:38:04 2013
@@ -73,7 +73,7 @@ public class TOP extends FeatureStructur
throw new RuntimeException("Internal Error: TOP() constructor should never be called.");
}
- /**
+ /*
* (Internal) make a new instance of TOP, linking it with a pre-existing Cas FeatureStructure
* object. Note: this function invoked via the generator in TOP_Type whenever the CAS needs to
* make a java instance
@@ -83,7 +83,7 @@ public class TOP extends FeatureStructur
this.jcasType = jcasType;
}
- /**
+ /*
* (Internal) create a new instance of TOP (or subclass of TOP) in Java and Cas, and make them
* correspond.
*/
@@ -109,28 +109,36 @@ public class TOP extends FeatureStructur
}
}
- /** add the corresponding FeatureStructure to all Cas indexes */
+ /** add the corresponding FeatureStructure to all Cas indexes in the view where this FS was created*/
public void addToIndexes() {
addToIndexes(jcasType.jcas);
}
-
+
+ /**
+ * add this FS to indexes in a specific view, perhaps different from the creation view
+ * @param jcas the JCas
+ */
public void addToIndexes(JCas jcas) {
jcas.getCas().addFsToIndexes(this);
}
- /** remove the corresponding FeatureStructure from all Cas indexes */
+ /** remove the corresponding FeatureStructure from all Cas indexes in the view where this FS was created */
public void removeFromIndexes() {
removeFromIndexes(jcasType.jcas);
}
+ /**
+ * remove this FS from indices in a specific view, perhaps different from the view where this was created.
+ * @param jcas the JCas
+ */
public void removeFromIndexes(JCas jcas) {
jcas.getLowLevelIndexRepository().ll_removeFS(this.addr);
}
/*
- * functions needed to to implement the FeatureStructure interface Note we don't simply implement
- * this class as a subclass of FeatureStructureImpl because that would add one more slot to every
- * instance
+ * functions needed to to implement the FeatureStructure interface
+ * Note we don't simply implement this class as a subclass of FeatureStructureImpl
+ * because that would add one more slot to every instance
*/
public int getAddress() {
@@ -141,6 +149,9 @@ public class TOP extends FeatureStructur
return jcasType.casImpl;
}
+ /**
+ * @return the CAS view where this FS was created
+ */
public CAS getCAS() {
return jcasType.casImpl;
}
Modified: uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/TOP_Type.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/TOP_Type.java?rev=1549640&r1=1549639&r2=1549640&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/TOP_Type.java (original)
+++ uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/cas/TOP_Type.java Mon Dec 9 18:38:04 2013
@@ -129,7 +129,7 @@ public class TOP_Type {
throw new RuntimeException("Internal Error-this constructor should never be called.");
}
- /**
+ /*
* Internal - this constructor is called when new CAS creates corresponding jcas instance. During
* this process, all the types defined in the CAS are used to see if there are any corresponding
* jcas type defs defined. If so, they are loaded. This constructor is called via its being the
@@ -141,7 +141,7 @@ public class TOP_Type {
this(jcas, casType, true);
}
- /**
+ /*
* DO NOT USE - for backwards compatibility only.
*/
// constructor execution order: 1: super, 2: instance expr, 3: body
@@ -185,12 +185,18 @@ public class TOP_Type {
throw e;
}
- /** add the corresponding FeatureStructure to all Cas indexes */
+ /**
+ * add the corresponding FeatureStructure to all Cas indexes
+ * @param inst the low level CAS Feature Structure reference
+ */
public void addToIndexes(int inst) {
jcas.getLowLevelIndexRepository().ll_addFS(inst);
}
- /** remove the corresponding FeatureStructure from all Cas indexes */
+ /**
+ * remove the corresponding FeatureStructure from all Cas indexes
+ * @param inst the low level CAS Feature Structure reference
+ */
public void removeFromIndexes(int inst) {
jcas.getLowLevelIndexRepository().ll_removeFS(inst);
}