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 2016/11/08 16:12:11 UTC
svn commit: r1768720 - in
/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima:
cas/impl/ internal/util/
Author: schor
Date: Tue Nov 8 16:12:11 2016
New Revision: 1768720
URL: http://svn.apache.org/viewvc?rev=1768720&view=rev
Log:
[UIMA-5172] fix javadocs for java 8 style
Modified:
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes4.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes6.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CASImpl.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CASMgrSerializer.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSeqAddrMaps.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSerializerSupport.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasTypeSystemMapper.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSClassRegistry.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSComparator.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexRepositoryImpl.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FeatureStructureImplC.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_bag.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_flat.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_set_sorted.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_singletype.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/LowLevelIndex.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/SelectFSs_impl.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/CopyOnWriteObjHashSet.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/CopyOnWriteOrderedFsSet_array.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/Misc.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/Obj2IntIdentityHashMap.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/ObjHashSet.java
uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/OrderedFsSet_array.java
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes.java Tue Nov 8 16:12:11 2016
@@ -494,8 +494,9 @@ public class BinaryCasSerDes {
* @param casLoadMode DEFAULT or REINIT. REINIT required with compressed form 6 to
* reinitialize the cas's type system and index definition, for form 6.
* @param f6 only used for form 6 where an instance of BinaryCasSerDes6 has been initialized
- * @param allowPreexistingFS only used for form 6 delta deserialization
- * @return -
+ * @param allowPreexistingFS only used for form 6 delta deserialization
+ * @param ts the type system
+ * @return the format that was deserialized
* @throws CASRuntimeException wraps IOException
*/
public SerialFormat reinit(Header h,
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes4.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes4.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes4.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes4.java Tue Nov 8 16:12:11 2016
@@ -2635,7 +2635,7 @@ public class BinaryCasSerDes4 implements
}
}
- /********************************************************************
+ /* ******************************************************************
* methods common to serialization / deserialization etc.
********************************************************************/
@@ -3199,7 +3199,7 @@ public class BinaryCasSerDes4 implements
// }
// }
- /**
+ /*
* debugging and dumping
*/
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes6.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes6.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes6.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/BinaryCasSerDes6.java Tue Nov 8 16:12:11 2016
@@ -3030,7 +3030,7 @@ public class BinaryCasSerDes6 implements
* If the type systems are different, construct a type mapper and use that
* to selectively ignore types or features not in other type system
*
- * The Mapper is from CAS1 -> CAS2
+ * The Mapper is from CAS1 -> CAS2
*
* When computing the things to compare from CAS1, filter to remove
* feature structures not reachable via indexes or refs
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CASImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CASImpl.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CASImpl.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CASImpl.java Tue Nov 8 16:12:11 2016
@@ -1670,9 +1670,9 @@ public class CASImpl extends AbstractCas
/**
* This method called by setters in JCas gen'd classes when
* the setter must check for journaling
- * @param fs
- * @param fi
- * @param setter
+ * @param fs -
+ * @param fi -
+ * @param setter -
*/
public void setWithJournal(FeatureStructureImplC fs, FeatureImpl fi, Runnable setter) {
setter.run();
@@ -1737,9 +1737,9 @@ public class CASImpl extends AbstractCas
* Only called from FeatureStructureImplC after determining
* there is no local field to use
* Is here because of 3 calls to things in this class
- * @param fs the feature structure
+ * @param fsIn the feature structure
* @param feat the feature to set
- * @param value -
+ * @param v -
*/
public void setLongValue(FeatureStructureImplC fsIn, FeatureImpl feat, long v) {
TOP fs = (TOP) fsIn;
@@ -2371,7 +2371,7 @@ public class CASImpl extends AbstractCas
}
/**
- * @param arrayLength
+ * @param arrayLength -
* @return the id of the created array
*/
@Override
@@ -2382,7 +2382,7 @@ public class CASImpl extends AbstractCas
}
/**
- * @param arrayLength
+ * @param arrayLength -
* @return the id of the created array
*/
@Override
@@ -2393,7 +2393,7 @@ public class CASImpl extends AbstractCas
}
/**
- * @param arrayLength
+ * @param arrayLength -
* @return the id of the created array
*/
@Override
@@ -2404,7 +2404,7 @@ public class CASImpl extends AbstractCas
}
/**
- * @param arrayLength
+ * @param arrayLength -
* @return the id of the created array
*/
@Override
@@ -2415,7 +2415,7 @@ public class CASImpl extends AbstractCas
}
/**
- * @param arrayLength
+ * @param arrayLength -
* @return the id of the created array
*/
@Override
@@ -2426,7 +2426,7 @@ public class CASImpl extends AbstractCas
}
/**
- * @param arrayLength
+ * @param arrayLength -
* @return the id of the created array
*/
@Override
@@ -2480,9 +2480,9 @@ public class CASImpl extends AbstractCas
* feature range is int - normal
* feature range is a fs reference, return the id
* feature range is a string: add the string if not already present to the string heap, return the int handle.
- * @param fsRef
- * @param featureCode
- * @return
+ * @param fsRef -
+ * @param featureCode -
+ * @return -
*/
@Override
public final int ll_getIntValue(int fsRef, int featureCode) {
@@ -2763,10 +2763,10 @@ public class CASImpl extends AbstractCas
* Only called if there was something removed that needs to be added back
*
* skip the addback (to defer it until later) if:
- * - running in block mode (you can tell this if svd.fssTobeAddedback.size() > 0) or
+ * - running in block mode (you can tell this if svd.fssTobeAddedback.size() > 0) or
* if running in block mode, the add back is delayed until the end of the block
*
- * @param fsRef the fs to add back
+ * @param fs the fs to add back
*/
public void maybeAddback(TOP fs) {
if (svd.fssTobeAddedback.size() == 0) {
@@ -3873,7 +3873,6 @@ public class CASImpl extends AbstractCas
* creates the document annotation if not present
* only works if not in the base cas
*
- * @return the document annotation
*/
public void updateDocumentAnnotation() {
if (!mySofaIsValid() || this == this.svd.baseCAS) {
@@ -4475,7 +4474,7 @@ public class CASImpl extends AbstractCas
/**
* Test case use
- * @param fs the fs to include in the id 2 fs map
+ * @param fss the FSs to include in the id 2 fs map
*/
public void setId2FSs(FeatureStructure ... fss) {
for (FeatureStructure fs : fss) {
@@ -4636,8 +4635,8 @@ public class CASImpl extends AbstractCas
/**
* Get an empty list from the type code of a list
- * @param rangeCode
- * @return
+ * @param rangeCode -
+ * @return -
*/
public EmptyList getEmptyListFromTypeCode(int rangeCode) {
switch (rangeCode) {
@@ -4819,7 +4818,7 @@ public class CASImpl extends AbstractCas
return (T) r;
}
- /******************************************
+ /* *****************************************
* DEBUGGING and TRACING
******************************************/
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CASMgrSerializer.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CASMgrSerializer.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CASMgrSerializer.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CASMgrSerializer.java Tue Nov 8 16:12:11 2016
@@ -464,8 +464,8 @@ public class CASMgrSerializer implements
/**
* Deserialize the index specification and type ordering information in this class instance into the
* index repository and cas and type system.
- * @param cas
- * @return
+ * @param cas -
+ * @return -
*/
public FSIndexRepositoryImpl getIndexRepository(CASImpl cas) {
final FSIndexRepositoryImpl ir = new FSIndexRepositoryImpl(cas); // built-in indexes not added yet
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSeqAddrMaps.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSeqAddrMaps.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSeqAddrMaps.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSeqAddrMaps.java Tue Nov 8 16:12:11 2016
@@ -92,7 +92,7 @@ public class CasSeqAddrMaps {
/**
* Add a new FS id - done during prescan of source during serialization
* Must call in heap scan order
- * @param srcId -
+ * @param srcFs -
* @param tgtId -
* @param inTarget true if this type is in the target
*/
@@ -105,7 +105,7 @@ public class CasSeqAddrMaps {
/**
* Called during deserialize to incrementally add
- * @param srcAddr -
+ * @param srcFs -
* @param inSrc -
*/
public void addSrcFsForTgt(TOP srcFs, boolean inSrc) {
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSerializerSupport.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSerializerSupport.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSerializerSupport.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasSerializerSupport.java Tue Nov 8 16:12:11 2016
@@ -235,7 +235,7 @@ public class CasSerializerSupport {
/**
*
- * @param addr -
+ * @param fs -
* @param typeCode -
* @return true if writing out referenced items (JSON)
* @throws Exception -
@@ -1095,8 +1095,7 @@ public class CasSerializerSupport {
* a generated feature name, "@collection" whose value is
* the list or array of values associated with that type.
*
- * @param addr
- * The address to be encoded.
+ * @param fs the FS to be encoded.
* @throws SAXException passthru
*/
public void encodeFS(TOP fs) throws Exception {
@@ -1149,9 +1148,8 @@ public class CasSerializerSupport {
/**
* Get the XMI ID to use for an FS.
*
- * @param addr
- * address of FS
- * @return XMI ID. If addr == CASImpl.NULL, returns null
+ * @param fs the FS
+ * @return XMI ID or null
*/
public String getXmiId(TOP fs) {
int v = getXmiIdAsInt(fs);
@@ -1246,8 +1244,7 @@ public class CasSerializerSupport {
* method can return one of the type codes TYPE_CLASS_INTLIST, TYPE_CLASS_FLOATLIST,
* TYPE_CLASS_STRINGLIST, or TYPE_CLASS_FSLIST.
*
- * @param typeCode
- * the type to classify
+ * @param ti the type to classify
* @return one of the TYPE_CLASS codes defined on {@link LowLevelCAS} or on this interface.
*/
public static final int classifyType(TypeImpl ti) {
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasTypeSystemMapper.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasTypeSystemMapper.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasTypeSystemMapper.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/CasTypeSystemMapper.java Tue Nov 8 16:12:11 2016
@@ -125,8 +125,8 @@ public class CasTypeSystemMapper {
}
/**
- * @param c -
- * @return 0 if type doesn't have corresponding code in other type system
+ * @param srcType -
+ * @return Type in other type system, or this one if map is empty
*/
public TypeImpl mapTypeSrc2Tgt(TypeImpl srcType) {
return (tSrc2Tgt.size() == 0) ? srcType : tSrc2Tgt.get(srcType.getCode());
@@ -137,7 +137,7 @@ public class CasTypeSystemMapper {
// }
/**
- * @param c -
+ * @param tgtType -
* @return 0 if type doesn't have corresponding code in other type system
*/
public TypeImpl mapTypeTgt2Src(TypeImpl tgtType) {
@@ -150,7 +150,7 @@ public class CasTypeSystemMapper {
/**
*
- * @param c -
+ * @param type -
* @param src2tgt -
* @return 0 if type doesn't have corresponding code in other type system
*/
@@ -175,7 +175,7 @@ public class CasTypeSystemMapper {
/**
* Given a tgt type, return an array of source features in the order
* they would appear in the target.
- * @param tgtType
+ * @param tgtType -
* @return array of corresponding source features, in target type order
*/
public FeatureImpl[] getSrcFeatures(TypeImpl tgtType) {
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSClassRegistry.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSClassRegistry.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSClassRegistry.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSClassRegistry.java Tue Nov 8 16:12:11 2016
@@ -83,10 +83,10 @@ import org.apache.uima.util.Logger;
* - These instances share the same int[] and Object[] and _typeImpl and _casView refs with the outer class loader's FS
*
* Timing / life cycle
- * Built-in classes loaded & initialized at first type system commit time.
- * non-pear classes loaded & initialized at type system commit time (if not already loaded)
+ * Built-in classes loaded and initialized at first type system commit time.
+ * non-pear classes loaded and initialized at type system commit time (if not already loaded)
* - special checks for conformability if some types loaded later, due to requirements for computing feature offsets at load time
- * pear classes loaded & initialized at first entry to Pear, for a given type system and class loader.
+ * pear classes loaded and initialized at first entry to Pear, for a given type system and class loader.
*
*
* At typeSystemCommit time, this class is created and initialized:
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSComparator.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSComparator.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSComparator.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSComparator.java Tue Nov 8 16:12:11 2016
@@ -22,7 +22,7 @@ package org.apache.uima.cas.impl;
import org.apache.uima.cas.FeatureStructure;
/**
- * Delete REplace with Comparator<FeatureStructure> or the like.
+ * Delete REplace with Comparator<FeatureStructure> or the like.
* Interface to compare two feature structures.
*
*/
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexRepositoryImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexRepositoryImpl.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexRepositoryImpl.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FSIndexRepositoryImpl.java Tue Nov 8 16:12:11 2016
@@ -1799,6 +1799,7 @@ public class FSIndexRepositoryImpl imple
/**
* Get the FsIndex_iicp for a given typeCode, indexingStrategy, and comparator (type ignored)
+ * @param typeCode -
* @param indexingStrategy -
* @param comp -
* @param <T> type of Feature Structure
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FeatureStructureImplC.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FeatureStructureImplC.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FeatureStructureImplC.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FeatureStructureImplC.java Tue Nov 8 16:12:11 2016
@@ -162,7 +162,7 @@ public class FeatureStructureImplC imple
/**
* For use in creating search keys
- * @param id
+ * @param id -
*/
protected FeatureStructureImplC(int id) {
_casView = null;
@@ -299,7 +299,7 @@ public class FeatureStructureImplC imple
/**
* remove this FS from indexes in a specific view, perhaps different from the view where this was created.
- * @param cas the Cas
+ * @param jcas the Cas
*/
public void removeFromIndexes(JCas jcas) {
jcas.removeFsFromIndexes(this);
@@ -559,6 +559,7 @@ public class FeatureStructureImplC imple
/**
* Called when setting a FS value which might be a trampoline
* @param v the FS to check
+ * @param <N> the type of the FS
* @return the FS or if it was a trampoline, the base FS
*/
protected <N extends TOP> N _maybeGetBaseForPearFs(N v) {
@@ -572,6 +573,7 @@ public class FeatureStructureImplC imple
/**
* Called when getting a FS value which might need to return a Pear context's trampoline
* @param v the FS to check
+ * @param <N> the type of the FS
* @return the FS or if we're in a Pear context, perhaps the trampoline (only some classes might have trampolines)
*/
protected <N extends TOP> N _maybeGetPearFs(N v) {
@@ -582,8 +584,8 @@ public class FeatureStructureImplC imple
/**
* Nc - no check, Wj = with journaling if needed
- * @param adjOffset
- * @param v
+ * @param adjOffset -
+ * @param v -
*/
public void _setFeatureValueNcWj(int adjOffset, FeatureStructure v) {
_setRefValueCommonWj(_getFeatFromAdjOffset(adjOffset, false), _maybeGetBaseForPearFs((TOP)v));
@@ -642,7 +644,7 @@ public class FeatureStructureImplC imple
/**
* 2 checks, no feature check
- * @param fi - the feature
+ * @param adjOffset - the feature offset
* @param v - the value
*/
protected void _setIntValueNfcCJ(int adjOffset, int v) {
@@ -1166,9 +1168,9 @@ public class FeatureStructureImplC imple
/**
* for compressed form 4 - for getting the prev value of int-like slots
* Uses unchecked forms for feature access
- * @param slotKind
- * @param fi
- * @param v
+ * @param slotKind -
+ * @param f -
+ * @return -
*/
public int _getIntLikeValue(SlotKind slotKind, FeatureImpl f) {
if (null == f) {
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_bag.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_bag.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_bag.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_bag.java Tue Nov 8 16:12:11 2016
@@ -154,7 +154,7 @@ public class FsIndex_bag<T extends Featu
/**
* This is a silly method for bag indexes in V3, since dupl add to indexes is not allowed.
- * @param fs
+ * @param fs -
* @return null or the original fs if the fs is in the index
*/
@Override
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_flat.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_flat.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_flat.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_flat.java Tue Nov 8 16:12:11 2016
@@ -154,7 +154,7 @@ public class FsIndex_flat<T extends Feat
}
/**
- * @see org.apache.uima.cas.impl.FsIndex_singletype#deleteFS(T)
+ * @see org.apache.uima.cas.impl.FsIndex_singletype#deleteFS(FeatureStructure)
*/
@Override
public boolean deleteFS(T fs) {
@@ -175,7 +175,7 @@ public class FsIndex_flat<T extends Feat
}
/**
- * @see org.apache.uima.cas.FSIndex#compare(T, T)
+ * @see org.apache.uima.cas.FSIndex#compare(FeatureStructure, FeatureStructure)
*/
@Override
public int compare(FeatureStructure fs1, FeatureStructure fs2) {
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_set_sorted.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_set_sorted.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_set_sorted.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_set_sorted.java Tue Nov 8 16:12:11 2016
@@ -99,7 +99,7 @@ public class FsIndex_set_sorted<T extend
/**
* @see org.apache.uima.cas.FSIndex#contains(FeatureStructure)
- * @param fs the feature structure
+ * @param templateKey the feature structure
* @return true if the fs is contained
*/
@Override
@@ -140,7 +140,7 @@ public class FsIndex_set_sorted<T extend
* -- if it is GT, then the ones preceding it are LessThan (using cpx) the key.
* Do the same check as above to see if the last of the preceding ones is equal using cp.
*
- * @param fs the matching fs template
+ * @param templateKey the matching fs template
* @return an arbitrary fs that matches
*/
@Override
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_singletype.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_singletype.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_singletype.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/FsIndex_singletype.java Tue Nov 8 16:12:11 2016
@@ -116,6 +116,7 @@ public abstract class FsIndex_singletype
* @param cas -
* @param type -
* @param indexType -
+ * @param comparatorForIndexSpecs -
*/
protected FsIndex_singletype(CASImpl cas, Type type, int indexType, FSIndexComparator comparatorForIndexSpecs) {
super();
@@ -227,7 +228,7 @@ public abstract class FsIndex_singletype
}
/**
- * @see org.apache.uima.cas.FSIndex#compare(T, T)
+ * @see org.apache.uima.cas.FSIndex#compare(FeatureStructure, FeatureStructure)
*/
@Override
public int compare(FeatureStructure afs1, FeatureStructure afs2) {
@@ -340,7 +341,7 @@ public abstract class FsIndex_singletype
}
/**
- * For serialization: get all the items in this index and bulk add to an List<T>
+ * For serialization: get all the items in this index and bulk add to an List<T>
* @param v the set of items to add
*/
protected abstract void bulkAddTo(List<T> v);
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/LowLevelIndex.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/LowLevelIndex.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/LowLevelIndex.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/LowLevelIndex.java Tue Nov 8 16:12:11 2016
@@ -107,6 +107,7 @@ public interface LowLevelIndex<T extends
/**
* @param ti type which is a subtype of this index's type
+ * @param <U> the type the subindex is over
* @return the index but just over this subtype
*/
default <U extends T> LowLevelIndex<U> getSubIndex(TypeImpl ti) {
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/SelectFSs_impl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/SelectFSs_impl.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/SelectFSs_impl.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/cas/impl/SelectFSs_impl.java Tue Nov 8 16:12:11 2016
@@ -141,8 +141,10 @@ public class SelectFSs_impl <T extends F
/**
* INDEX
* If not specified, defaults to all FSs (unordered) unless AnnotationIndex implied
+ * @param indexName -
+ * @param <N> type of returned Feature Structures
+ * @return -
*/
-
public <N extends FeatureStructure> SelectFSs_impl<N> index(String indexName) {
this.index = view.indexRepository.getIndex(indexName);
return (SelectFSs_impl<N>) this;
@@ -1003,15 +1005,14 @@ public class SelectFSs_impl <T extends F
* works for AnnotationIndex or general index
*
* position taken from startingFs (not necessarily an Annotation subtype)
- * - goes to left-most "equal" using comparator, or if none equal, to the first one > startingFs
+ * - goes to left-most "equal" using comparator, or if none equal, to the first one > startingFs
* -- using moveTo(fs)
*
* special processing for AnnotationIndex (only):
* - typePriority - use or ignore
- * -- ignored: after moveTo(fs), moveToPrevious while begin && end ==
+ * -- ignored: after moveTo(fs), moveToPrevious while begin and end ==
* --- and if isPositionUsesType types are ==
* @param it iterator to position
- * @param <T> type of result
* @return it positioned if needed
*/
public FSIterator<T> maybePosition(FSIterator<T> it) {
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/CopyOnWriteObjHashSet.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/CopyOnWriteObjHashSet.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/CopyOnWriteObjHashSet.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/CopyOnWriteObjHashSet.java Tue Nov 8 16:12:11 2016
@@ -22,6 +22,7 @@ import java.util.Iterator;
import org.apache.uima.cas.FeatureStructure;
import org.apache.uima.cas.impl.CopyOnWriteIndexPart;
+import org.apache.uima.internal.util.ObjHashSet;
/**
* implements ObjHashSet partially, for iterator use
@@ -109,21 +110,24 @@ public class CopyOnWriteObjHashSet<T> im
}
/**
- * @see org.apache.uima.internal.util.ObjHashSet#getModificationCount()
+ * @see ObjHashSet#getModificationCount()
+ * @return the modification count
*/
public int getModificationCount() {
return ohs.getModificationCount();
}
/**
- * @see org.apache.uima.internal.util.ObjHashSet#getCapacity()
+ * @see ObjHashSet#getCapacity()
+ * @return the capacity >= size
*/
public int getCapacity() {
return ohs.getCapacity();
}
/**
- * @see org.apache.uima.internal.util.ObjHashSet#size()
+ * @see ObjHashSet#size()
+ * @return the size
*/
public int size() {
return ohs.size();
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/CopyOnWriteOrderedFsSet_array.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/CopyOnWriteOrderedFsSet_array.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/CopyOnWriteOrderedFsSet_array.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/CopyOnWriteOrderedFsSet_array.java Tue Nov 8 16:12:11 2016
@@ -30,6 +30,7 @@ import java.util.stream.Stream;
import org.apache.uima.cas.impl.CopyOnWriteIndexPart;
import org.apache.uima.jcas.cas.TOP;
+import org.apache.uima.internal.util.OrderedFsSet_array;
/**
* implements OrderedFsSet_array partially, for iterator use
@@ -81,7 +82,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#comparator()
+ * @see OrderedFsSet_array#comparator()
*/
@Override
public Comparator<? super TOP> comparator() {
@@ -89,7 +90,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#first()
+ * @see OrderedFsSet_array#first()
*/
@Override
public TOP first() {
@@ -97,7 +98,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#last()
+ * @see OrderedFsSet_array#last()
*/
@Override
public TOP last() {
@@ -105,7 +106,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#size()
+ * @see OrderedFsSet_array#size()
*/
@Override
public int size() {
@@ -113,7 +114,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#isEmpty()
+ * @see OrderedFsSet_array#isEmpty()
*/
@Override
public boolean isEmpty() {
@@ -121,7 +122,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#contains(java.lang.Object)
+ * @see OrderedFsSet_array#contains(java.lang.Object)
*/
@Override
public boolean contains(Object o) {
@@ -129,7 +130,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#toArray()
+ * @see OrderedFsSet_array#toArray()
*/
@Override
public Object[] toArray() {
@@ -137,7 +138,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#toArray(java.lang.Object[])
+ * @see OrderedFsSet_array#toArray(java.lang.Object[])
*/
@Override
public <T> T[] toArray(T[] a1) {
@@ -145,7 +146,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#add(org.apache.uima.jcas.cas.TOP)
+ * @see OrderedFsSet_array#add(TOP)
*/
@Override
public boolean add(TOP fs) {
@@ -185,7 +186,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#remove(java.lang.Object)
+ * @see OrderedFsSet_array#remove(java.lang.Object)
*/
@Override
public boolean remove(Object o) {
@@ -193,7 +194,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#containsAll(java.util.Collection)
+ * @see OrderedFsSet_array#containsAll(java.util.Collection)
*/
@Override
public boolean containsAll(Collection<?> c) {
@@ -201,7 +202,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#addAll(java.util.Collection)
+ * @see OrderedFsSet_array#addAll(java.util.Collection)
*/
@Override
public boolean addAll(Collection<? extends TOP> c) {
@@ -209,7 +210,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#retainAll(java.util.Collection)
+ * @see OrderedFsSet_array#retainAll(java.util.Collection)
*/
@Override
public boolean retainAll(Collection<?> c) {
@@ -217,7 +218,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#removeAll(java.util.Collection)
+ * @see OrderedFsSet_array#removeAll(java.util.Collection)
*/
@Override
public boolean removeAll(Collection<?> c) {
@@ -226,7 +227,7 @@ public class CopyOnWriteOrderedFsSet_arr
/**
*
- * @see org.apache.uima.internal.util.OrderedFsSet_array#clear()
+ * @see OrderedFsSet_array#clear()
*/
@Override
public void clear() {
@@ -234,7 +235,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#lower(org.apache.uima.jcas.cas.TOP)
+ * @see OrderedFsSet_array#lower(TOP)
*/
@Override
public TOP lower(TOP fs) {
@@ -242,14 +243,16 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#lowerPos(org.apache.uima.jcas.cas.TOP)
+ * @see OrderedFsSet_array#lowerPos(TOP)
+ * @param fs the Feature Structure to use for positioning
+ * @return -
*/
public int lowerPos(TOP fs) {
return set.lowerPos(fs);
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#floor(org.apache.uima.jcas.cas.TOP)
+ * @see OrderedFsSet_array#floor(TOP)
*/
@Override
public TOP floor(TOP fs) {
@@ -257,14 +260,16 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#floorPos(org.apache.uima.jcas.cas.TOP)
+ * @see OrderedFsSet_array#floorPos(TOP)
+ * @param fs the Feature Structure to use for positioning
+ * @return -
*/
public int floorPos(TOP fs) {
return set.floorPos(fs);
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#ceiling(org.apache.uima.jcas.cas.TOP)
+ * @see OrderedFsSet_array#ceiling(TOP)
*/
@Override
public TOP ceiling(TOP fs) {
@@ -272,14 +277,16 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#ceilingPos(org.apache.uima.jcas.cas.TOP)
+ * @see OrderedFsSet_array#ceilingPos(TOP)
+ * @param fs the Feature Structure to use for positioning
+ * @return -
*/
public int ceilingPos(TOP fs) {
return set.ceilingPos(fs);
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#higher(org.apache.uima.jcas.cas.TOP)
+ * @see OrderedFsSet_array#higher(TOP)
*/
@Override
public TOP higher(TOP fs) {
@@ -287,14 +294,16 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#higherPos(org.apache.uima.jcas.cas.TOP)
+ * @see OrderedFsSet_array#higherPos(TOP)
+ * @param fs the Feature Structure to use for positioning
+ * @return -
*/
public int higherPos(TOP fs) {
return set.higherPos(fs);
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#pollFirst()
+ * @see OrderedFsSet_array#pollFirst()
*/
@Override
public TOP pollFirst() {
@@ -302,7 +311,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#pollLast()
+ * @see OrderedFsSet_array#pollLast()
*/
@Override
public TOP pollLast() {
@@ -310,7 +319,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#iterator()
+ * @see OrderedFsSet_array#iterator()
*/
@Override
public Iterator<TOP> iterator() {
@@ -318,7 +327,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#descendingSet()
+ * @see OrderedFsSet_array#descendingSet()
*/
@Override
public NavigableSet<TOP> descendingSet() {
@@ -326,7 +335,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#descendingIterator()
+ * @see OrderedFsSet_array#descendingIterator()
*/
@Override
public Iterator<TOP> descendingIterator() {
@@ -334,7 +343,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#subSet(org.apache.uima.jcas.cas.TOP, boolean, org.apache.uima.jcas.cas.TOP, boolean)
+ * @see OrderedFsSet_array#subSet(TOP, boolean, TOP, boolean)
*/
@Override
public NavigableSet<TOP> subSet(TOP fromElement, boolean fromInclusive, TOP toElement,
@@ -343,7 +352,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#headSet(org.apache.uima.jcas.cas.TOP, boolean)
+ * @see OrderedFsSet_array#headSet(TOP, boolean)
*/
@Override
public NavigableSet<TOP> headSet(TOP toElement, boolean inclusive) {
@@ -351,7 +360,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#tailSet(org.apache.uima.jcas.cas.TOP, boolean)
+ * @see OrderedFsSet_array#tailSet(TOP, boolean)
*/
@Override
public NavigableSet<TOP> tailSet(TOP fromElement, boolean inclusive) {
@@ -359,7 +368,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#subSet(org.apache.uima.jcas.cas.TOP, org.apache.uima.jcas.cas.TOP)
+ * @see OrderedFsSet_array#subSet(TOP, TOP)
*/
@Override
public SortedSet<TOP> subSet(TOP fromElement, TOP toElement) {
@@ -367,7 +376,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#headSet(org.apache.uima.jcas.cas.TOP)
+ * @see OrderedFsSet_array#headSet(TOP)
*/
@Override
public SortedSet<TOP> headSet(TOP toElement) {
@@ -375,7 +384,7 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#tailSet(org.apache.uima.jcas.cas.TOP)
+ * @see OrderedFsSet_array#tailSet(TOP)
*/
@Override
public SortedSet<TOP> tailSet(TOP fromElement) {
@@ -383,14 +392,14 @@ public class CopyOnWriteOrderedFsSet_arr
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#getModificationCount()
+ * @return the modification count
*/
public int getModificationCount() {
return set.getModificationCount();
}
/**
- * @see org.apache.uima.internal.util.OrderedFsSet_array#toString()
+ * @see OrderedFsSet_array#toString()
*/
@Override
public String toString() {
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/Misc.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/Misc.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/Misc.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/Misc.java Tue Nov 8 16:12:11 2016
@@ -137,6 +137,7 @@ public class Misc {
* Adds a collection of things (toString) separated by , and surrounded by [ ], to a StringBuilder
* @param sb where the formatted collection results are appended to
* @param c the collection
+ * @param <T> the kind of elements in the collection
* @return the StringBuilder for chaining
*/
public static <T> StringBuilder addElementsToStringBuilder(StringBuilder sb, Collection<T> c){
@@ -156,6 +157,8 @@ public class Misc {
* Adds a collection of things (running an appender to append the result to the same sb) separated by , and surrounded by [ ], to a StringBuilder
* @param sb where the formatted collection results are appended to
* @param c the collection
+ * @param appender the function for getting the value to append
+ * @param <T> the kind of elements in the collection
* @return the StringBuilder for chaining
*/
public static<T> StringBuilder addElementsToStringBuilder(StringBuilder sb, Collection<T> c, Consumer<T> appender){
@@ -228,11 +231,11 @@ public class Misc {
* Using that method handle is slow, but converting it to a lambda makes for
* JIT-able fast access.
*
- * @param clazz
- * @param methodHandleAccessContext
- * @param protectedMethod
- * @param args
- * @return
+ * @param clazz -
+ * @param methodHandleAccessContext -
+ * @param protectedMethod -
+ * @param args -
+ * @return -
*/
static public MethodHandle getProtectedMethodHandle(Class<?> clazz, Lookup methodHandleAccessContext, String protectedMethod, Class<?> ... args) {
try {
@@ -252,10 +255,10 @@ public class Misc {
*
* Using that method handle is slow, but converting it to a lambda makes for
* JIT-able fast access.
- * @param clazz
- * @param protectedMethod
- * @param args
- * @return
+ * @param clazz -
+ * @param protectedMethod -
+ * @param args -
+ * @return -
*/
static public MethodHandle getProtectedMethodHandle(Class<?> clazz, String protectedMethod, Class<?> ... args) {
return getProtectedMethodHandle(clazz, UIMAlookup, protectedMethod, args);
@@ -412,6 +415,7 @@ public class Misc {
* Items in this "set" are held with weak references, so may be gc'd if no longer referenced anywhere.
* @param obj - the object to use a cached substitute for, if one exists
* @param cache - the cache
+ * @param <T> the type of the cached object
* @return - the object or a cached version of it.
*/
public static <T> T shareExisting(T obj, WeakHashMap<T, WeakReference<T>> cache) {
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/Obj2IntIdentityHashMap.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/Obj2IntIdentityHashMap.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/Obj2IntIdentityHashMap.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/Obj2IntIdentityHashMap.java Tue Nov 8 16:12:11 2016
@@ -244,7 +244,8 @@ public class Obj2IntIdentityHashMap<T> {
/**
*
- * @param obj - the object to add
+ * @param obj the key
+ * @param value the value
* @return the previous value, or 0 if this map did not already contain the specified key
*/
public int put(T obj, int value) {
@@ -355,7 +356,7 @@ public class Obj2IntIdentityHashMap<T> {
/**
* advance pos until it points to a non 0 or is 1 past end
- * @param pos
+ * @param pos -
* @return updated pos
*/
public int moveToNextFilled(int pos) {
@@ -378,7 +379,7 @@ public class Obj2IntIdentityHashMap<T> {
/**
* decrement pos until it points to a non 0 or is -1
- * @param pos
+ * @param pos -
* @return updated pos
*/
public int moveToPreviousFilled(int pos) {
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/ObjHashSet.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/ObjHashSet.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/ObjHashSet.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/ObjHashSet.java Tue Nov 8 16:12:11 2016
@@ -93,7 +93,7 @@ public class ObjHashSet<T> implements Se
/**
* Copy constructor
- * @param ohs
+ * @param ohs -
*/
public ObjHashSet(ObjHashSet<T> ohs) {
this.removedMarker = ohs.removedMarker;
@@ -129,7 +129,9 @@ public class ObjHashSet<T> implements Se
// public boolean wontExpand(int n) {
// return (size + nbrRemoved + n) < sizeWhichTriggersExpansion;
// }
-
+ /**
+ * @return the current capacity, >= size
+ */
public int getCapacity() {
return keys.length;
}
@@ -328,13 +330,17 @@ public class ObjHashSet<T> implements Se
private boolean removeAtPosition(int pos) {
// found, remove it
- keys[pos] = (T) removedMarker; // at runtime, this cast is a no-op
+ keys[pos] = removedMarker; // at runtime, this cast is a no-op
size --;
modificationCount ++;
nbrRemoved ++;
return true;
}
+
+ /**
+ * @see Set#size()
+ */
@Override
public int size() {
return size;
@@ -382,7 +388,7 @@ public class ObjHashSet<T> implements Se
/**
* advance pos until it points to a non 0 or is 1 past end
- * @param pos
+ * @param pos -
* @return updated pos
*/
public int moveToNextFilled(int pos) {
@@ -405,7 +411,7 @@ public class ObjHashSet<T> implements Se
/**
* decrement pos until it points to a non 0 or is -1
- * @param pos
+ * @param pos -
* @return updated pos
*/
public int moveToPreviousFilled(int pos) {
@@ -590,7 +596,10 @@ public class ObjHashSet<T> implements Se
}
return anyChanged;
}
-
+
+ /**
+ * @return the modificiation count
+ */
public int getModificationCount() {
return modificationCount;
}
Modified: uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/OrderedFsSet_array.java
URL: http://svn.apache.org/viewvc/uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/OrderedFsSet_array.java?rev=1768720&r1=1768719&r2=1768720&view=diff
==============================================================================
--- uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/OrderedFsSet_array.java (original)
+++ uima/uimaj/branches/experiment-v3-jcas/uimaj-core/src/main/java/org/apache/uima/internal/util/OrderedFsSet_array.java Tue Nov 8 16:12:11 2016
@@ -29,6 +29,7 @@ import java.util.ConcurrentModificationE
import java.util.Iterator;
import java.util.NavigableSet;
import java.util.NoSuchElementException;
+import java.util.Set;
import java.util.SortedSet;
import org.apache.uima.jcas.cas.TOP;
@@ -134,11 +135,17 @@ public class OrderedFsSet_array implemen
this.lastRemovedPos = set.lastRemovedPos;
}
+ /**
+ * @see SortedSet#comparator()
+ */
@Override
public Comparator<? super TOP> comparator() {
return comparatorWithID;
}
+ /**
+ * @see SortedSet#first()
+ */
@Override
public TOP first() {
processBatch();
@@ -158,6 +165,9 @@ public class OrderedFsSet_array implemen
return null;
}
+ /**
+ * @see SortedSet#last()
+ */
@Override
public TOP last() {
processBatch();
@@ -177,17 +187,26 @@ public class OrderedFsSet_array implemen
return null;
}
+ /**
+ * @see Set#size()
+ */
@Override
public int size() {
processBatch();
return size;
}
+ /**
+ * @see Set#isEmpty()
+ */
@Override
public boolean isEmpty() {
return size == 0 && batch.size() == 0;
}
+ /**
+ * @see Set#contains(Object)
+ */
@Override
public boolean contains(Object o) {
if (o == null) {
@@ -201,6 +220,9 @@ public class OrderedFsSet_array implemen
return find(fs) >= 0;
}
+ /**
+ * @see Set#toArray()
+ */
@Override
public Object[] toArray() {
Object [] r = new Object[size()];
@@ -226,6 +248,9 @@ public class OrderedFsSet_array implemen
return r;
}
+ /**
+ * @see Set#toArray(Object[])
+ */
@SuppressWarnings("unchecked")
@Override
public <T> T[] toArray(T[] a1) {
@@ -246,9 +271,9 @@ public class OrderedFsSet_array implemen
/**
* Note: doesn't implement the return value; always returns true;
- * @param fs -
- * @return -
+ * @see Set#add(Object)
*/
+
@Override
public boolean add(TOP fs) {
if (highest == null) {
@@ -868,6 +893,9 @@ public class OrderedFsSet_array implemen
}
}
+ /**
+ * @see Set#remove(Object)
+ */
@Override
public boolean remove(Object o) {
processBatch();
@@ -934,11 +962,17 @@ public class OrderedFsSet_array implemen
lastRemovedPos = -1;
}
+ /**
+ * @see Set#containsAll(Collection)
+ */
@Override
public boolean containsAll(Collection<?> c) {
throw new UnsupportedOperationException();
}
+ /**
+ * @see Set#addAll(Collection)
+ */
@Override
public boolean addAll(Collection<? extends TOP> c) {
boolean changed = false;
@@ -948,16 +982,25 @@ public class OrderedFsSet_array implemen
return changed;
}
+ /**
+ * @see Set#retainAll(Collection)
+ */
@Override
public boolean retainAll(Collection<?> c) {
throw new UnsupportedOperationException();
}
+ /**
+ * @see Set#removeAll(Collection)
+ */
@Override
public boolean removeAll(Collection<?> c) {
throw new UnsupportedOperationException();
}
+ /**
+ * @see Set#clear()
+ */
@Override
public void clear() {
if (isEmpty()) {
@@ -990,6 +1033,9 @@ public class OrderedFsSet_array implemen
lastRemovedPos = -1;
}
+ /**
+ * @see NavigableSet#lower(Object)
+ */
@Override
public TOP lower(TOP fs) {
int pos = lowerPos(fs);
@@ -1015,12 +1061,19 @@ public class OrderedFsSet_array implemen
}
+ /**
+ * @see NavigableSet#floor(Object)
+ */
@Override
public TOP floor(TOP fs) {
int pos = floorPos(fs);
return (pos < 0) ? null : a[pos];
}
+ /**
+ * @param fs -
+ * @return -
+ */
public int floorPos(TOP fs) {
processBatch();
int pos = find(fs); // position of lowest item GE fs
@@ -1037,13 +1090,20 @@ public class OrderedFsSet_array implemen
return -1;
}
+ /**
+ * @see NavigableSet#ceiling(Object)
+ */
@Override
public TOP ceiling(TOP fs) {
int pos = ceilingPos(fs);
return (pos < a_nextFreeslot) ? a[pos] : null;
}
-
+
+ /**
+ * @param fs -
+ * @return -
+ */
public int ceilingPos(TOP fs) {
processBatch();
int pos = find(fs); // position of lowest item GE fs
@@ -1062,12 +1122,19 @@ public class OrderedFsSet_array implemen
return pos;
}
+ /**
+ * @see NavigableSet#higher(Object)
+ */
@Override
public TOP higher(TOP fs) {
int pos = higherPos(fs);
return (pos < a_nextFreeslot) ? a[pos] : null;
}
+ /**
+ * @param fs the Feature Structure to use for positioning
+ * @return the position that's higher
+ */
public int higherPos(TOP fs) {
processBatch();
int pos = find(fs); // position of lowest item GE fs
@@ -1082,16 +1149,25 @@ public class OrderedFsSet_array implemen
return pos;
}
+ /**
+ * @see NavigableSet#pollFirst()
+ */
@Override
public TOP pollFirst() {
throw new UnsupportedOperationException();
}
+ /**
+ * @see NavigableSet#pollLast()
+ */
@Override
public TOP pollLast() {
throw new UnsupportedOperationException();
}
+ /**
+ * @see Iterable#iterator()
+ */
@Override
public Iterator<TOP> iterator() {
processBatch();
@@ -1135,11 +1211,17 @@ public class OrderedFsSet_array implemen
};
}
+ /**
+ * @see NavigableSet#descendingSet()
+ */
@Override
public NavigableSet<TOP> descendingSet() {
throw new UnsupportedOperationException();
}
+ /**
+ * @see NavigableSet#descendingIterator()
+ */
@Override
public Iterator<TOP> descendingIterator() {
processBatch();
@@ -1179,11 +1261,17 @@ public class OrderedFsSet_array implemen
};
}
+ /**
+ * @see NavigableSet#subSet(Object, boolean, Object, boolean)
+ */
@Override
public NavigableSet<TOP> subSet(TOP fromElement, boolean fromInclusive, TOP toElement, boolean toInclusive) {
return new SubSet(fromElement, fromInclusive, toElement, toInclusive, false, null);
}
+ /**
+ * @see NavigableSet#headSet(Object, boolean)
+ */
@Override
public NavigableSet<TOP> headSet(TOP toElement, boolean inclusive) {
if (isEmpty()) {
@@ -1192,6 +1280,9 @@ public class OrderedFsSet_array implemen
return subSet(first(), true, toElement, inclusive);
}
+ /**
+ * @see NavigableSet#tailSet(Object, boolean)
+ */
@Override
public NavigableSet<TOP> tailSet(TOP fromElement, boolean inclusive) {
if (isEmpty()) {
@@ -1200,16 +1291,25 @@ public class OrderedFsSet_array implemen
return subSet(fromElement, inclusive, last(), true);
}
+ /**
+ * @see NavigableSet#subSet(Object, Object)
+ */
@Override
public SortedSet<TOP> subSet(TOP fromElement, TOP toElement) {
return subSet(fromElement, true, toElement, false);
}
+ /**
+ * @see NavigableSet#headSet(Object)
+ */
@Override
public SortedSet<TOP> headSet(TOP toElement) {
return headSet(toElement, false);
}
+ /**
+ * @see NavigableSet#tailSet(Object)
+ */
@Override
public SortedSet<TOP> tailSet(TOP fromElement) {
return tailSet(fromElement, true);