Skip to content

Commit

Permalink
HSEARCH-3425 Warnings: Invalid javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
yrodiere committed Feb 8, 2019
1 parent 395dbb9 commit e46a387
Show file tree
Hide file tree
Showing 9 changed files with 9 additions and 16 deletions.
Expand Up @@ -233,7 +233,7 @@ private void attemptOnePassEncoding() throws IOException {
* but simply stop and return as soon as the sink can't accept more data.
* Checking state of writer.flowControlPushingBack will reveal if everything
* was written.
* @throws IOException
* @throws IOException If writing fails.
*/
private void triggerFullWrite() throws IOException {
while ( nextBodyToEncodeIndex < bodyParts.size() ) {
Expand Down
Expand Up @@ -12,7 +12,7 @@
* Defines how a given value will be encoded as JSON and decoded from JSON.
* <p>
* Encodes values received from an {@link org.hibernate.search.engine.backend.document.IndexFieldAccessor} when indexing,
* and returns decoded values to the {@link org.hibernate.search.backend.elasticsearch.types.converter.impl.ElasticsearchFieldConverter}
* and returns decoded values to the {@link org.hibernate.search.backend.elasticsearch.search.projection.impl.ElasticsearchSearchProjection}
* when projecting in a search query.
*/
public interface ElasticsearchFieldCodec<F> {
Expand Down
Expand Up @@ -45,7 +45,8 @@ public class BulkWork implements ElasticsearchWork<BulkResult> {
* Whether to perform a refresh in the course of executing this bulk or not.
* <p>
* Note that this will refresh all indexes touched by this bulk,
* not only those given via {@link #indexesNeedingRefresh}. That's acceptable.
* not only those given via {@link ElasticsearchWorkExecutionContext#registerIndexToRefresh(URLEncodedString)}.
* That's acceptable.
* <p>
* If {@code true}, no additional refresh of the concerned indexes
* is needed after executing the bulk.
Expand Down
Expand Up @@ -33,7 +33,7 @@ public interface LuceneSearchProjection<E, T> extends SearchProjection<T>, Lucen
*
* @param projectionHitMapper The projection hit mapper used to transform hits to entities.
* @param luceneResult A wrapper on top of the Lucene document extracted from the index.
* @param context An execution context for the search projections.
* @param context An execution context for the extraction.
* @return The element extracted from the hit. Might be a key referring to an object that will be loaded by the
* {@link ProjectionHitMapper}. This returned object will be passed to {@link #transform(LoadingResult, Object, SearchProjectionTransformContext)}.
*/
Expand All @@ -47,7 +47,7 @@ E extract(ProjectionHitMapper<?, ?> projectionHitMapper, LuceneResult luceneResu
* {@link ProjectionHitMapper}.
* @param extractedData The extracted data to transform, coming from the
* {@link #extract(ProjectionHitMapper, LuceneResult, SearchProjectionExtractContext)} method.
* @param context
* @param context An execution context for the transforming.
* @return The final result considered as a hit.
*/
T transform(LoadingResult<?> loadingResult, E extractedData,
Expand Down
Expand Up @@ -48,7 +48,7 @@ static ManagedMultiReader createInstance(Set<ReaderProvider> readerProviders) th

@Override
protected synchronized void doClose() {
/**
/*
* Important: we don't really close the sub readers but we delegate to the
* close method of the managing ReaderProvider, which might reuse the same
* IndexReader.
Expand Down
Expand Up @@ -140,8 +140,6 @@ private void loadAllFromQueue(SessionImplementor session) throws Exception {
* @param listIds the list of entity identifiers (of type
* @param session the session to be used
* @param workExecutor the work executor to be used
*
* @throws InterruptedException
*/
private void loadList(List<Serializable> listIds, SessionImplementor session, PojoSessionWorkExecutor workExecutor) throws Exception {
try {
Expand Down
Expand Up @@ -55,7 +55,7 @@ public class IdentifierProducer implements StatelessSessionAwareRunnable {
* @param sessionFactory the Hibernate SessionFactory to use to load entities
* @param objectLoadingBatchSize affects mostly the next consumer: IdentifierConsumerEntityProducer
* @param indexedType the entity type to be loaded
* @param monitor
* @param monitor the indexing monitor
* @param objectsLimit if not zero
* @param idFetchSize the fetch size
* @param tenantId the tenant identifier
Expand Down
Expand Up @@ -65,14 +65,9 @@ public MassIndexerImpl(SessionFactoryImplementor sessionFactory, String tenantId
this.monitor = new SimpleIndexingProgressMonitor();
}

/**
/*
* From the set of classes a new set is built containing all indexed
* subclasses, but removing then all subtypes of indexed entities.
*
* @param mapping
* @param selection
*
* @return a new set of entities
*/
private static Set<Class<?>> toRootEntities(HibernateOrmMapping mapping, Class<?>... selection) {
//first build the "entities" set containing all indexed subtypes of "selection".
Expand Down
Expand Up @@ -60,7 +60,6 @@
* }
* </code></pre>
*
* @hsearch.experimental Spatial support is still considered experimental
* @author Nicolas Helleringer
*/
@PropertyBridgeMapping(bridge = @PropertyBridgeRef(
Expand Down

0 comments on commit e46a387

Please sign in to comment.