JaroslavTulach commented on a change in pull request #3209: URL: https://github.com/apache/netbeans/pull/3209#discussion_r721856062
########## File path: ide/parsing.indexing/src/org/netbeans/modules/parsing/impl/indexing/FilteringIterable.java ########## @@ -0,0 +1,84 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.netbeans.modules.parsing.impl.indexing; + +import java.util.Iterator; +import java.util.NoSuchElementException; +import java.util.function.Function; + +/** + * Iterable wrapping another iterable, yielding an interator, that only offers + * values, for this the supplied filter returns a true value. + */ +public class FilteringIterable<T> implements Iterable<T> { Review comment: Factory method is better than (subclassable!) class. A candidate for `NbCollections` extension, I guess. ########## File path: ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/IndexabilityQueryImplementation.java ########## @@ -0,0 +1,82 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.netbeans.modules.parsing.spi.indexing; + +import java.net.URL; +import javax.swing.event.ChangeListener; +import org.openide.filesystems.FileObject; + +/** + * Determine whether files should be skipped for indexing. + * <p> + * Global lookup is used to find all instances of + * IndexabilityQueryImplementation. + * </p> + * <p> + * Threading note: implementors should avoid acquiring locks that might be held + * by other threads. Generally treat this interface similarly to SPIs in + * {@link org.openide.filesystems} with respect to threading semantics. + * </p> + * + * @see org.netbeans.api.queries.IndexabilityQuery + * @since org.netbeans.modules.parsing.indexing 9.22.0 + */ +public interface IndexabilityQueryImplementation { + + /** + * Determine if the supplied file object should be indexed. Review comment: I assume the result must be stable for a `FileObject` until a change event is fired. What will happen when a module providing this implementation is uninstalled or new version (with different behavior) is installed? ########## File path: ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/IndexabilityQueryImplementation.java ########## @@ -0,0 +1,82 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.netbeans.modules.parsing.spi.indexing; + +import java.net.URL; +import javax.swing.event.ChangeListener; +import org.openide.filesystems.FileObject; + +/** + * Determine whether files should be skipped for indexing. + * <p> + * Global lookup is used to find all instances of + * IndexabilityQueryImplementation. + * </p> + * <p> + * Threading note: implementors should avoid acquiring locks that might be held + * by other threads. Generally treat this interface similarly to SPIs in + * {@link org.openide.filesystems} with respect to threading semantics. + * </p> + * + * @see org.netbeans.api.queries.IndexabilityQuery + * @since org.netbeans.modules.parsing.indexing 9.22.0 + */ +public interface IndexabilityQueryImplementation { + + /** + * Determine if the supplied file object should be indexed. + * + * @param fo file object to be indexed + * @return true if indexing should be prevented + */ + default boolean preventIndexing(FileObject fo) { Review comment: Is the "duality" of two `default` methods (which [are usually bad](http://wiki.apidesign.org/wiki/DefaultMethods) in an API as they increase fuzziness) necessary? Since [ability to return non-existing files](https://bits.netbeans.org/12.5/javadoc/org-openide-filesystems/apichanges.html#getFileObjectNonExisting) we may not need the `URI` variant at all. ########## File path: ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/IndexabilityQueryImplementation.java ########## @@ -0,0 +1,82 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.netbeans.modules.parsing.spi.indexing; + +import java.net.URL; +import javax.swing.event.ChangeListener; +import org.openide.filesystems.FileObject; + +/** + * Determine whether files should be skipped for indexing. + * <p> + * Global lookup is used to find all instances of + * IndexabilityQueryImplementation. + * </p> + * <p> + * Threading note: implementors should avoid acquiring locks that might be held + * by other threads. Generally treat this interface similarly to SPIs in + * {@link org.openide.filesystems} with respect to threading semantics. + * </p> + * + * @see org.netbeans.api.queries.IndexabilityQuery + * @since org.netbeans.modules.parsing.indexing 9.22.0 + */ +public interface IndexabilityQueryImplementation { + + /** + * Determine if the supplied file object should be indexed. + * + * @param fo file object to be indexed + * @return true if indexing should be prevented + */ + default boolean preventIndexing(FileObject fo) { + return false; + } + + /** + * Determine if the supplied indexable should be indexed using the given + * indexer (identified either by the name of the indexer or its factory + * class). + * + * @param indexerName name of the indexer that will be invoked on the + * indexable + * @param factoryClassName class name of the factory for the indexer that + * will be invoked on the indexable + * @param indexable the file that is about to be indexed Review comment: I suggest to get ready for [evolution](http://wiki.apidesign.org/wiki/Evolution) of this method. Instead of this multi-parameter callback method, consider creating an [open space](http://wiki.apidesign.org/wiki/APIvsSPI) `public final class` parameter. ########## File path: ide/parsing.indexing/src/org/netbeans/modules/parsing/spi/indexing/IndexabilityQueryImplementation.java ########## @@ -0,0 +1,82 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.netbeans.modules.parsing.spi.indexing; + +import java.net.URL; +import javax.swing.event.ChangeListener; +import org.openide.filesystems.FileObject; + +/** + * Determine whether files should be skipped for indexing. + * <p> + * Global lookup is used to find all instances of + * IndexabilityQueryImplementation. + * </p> + * <p> + * Threading note: implementors should avoid acquiring locks that might be held + * by other threads. Generally treat this interface similarly to SPIs in + * {@link org.openide.filesystems} with respect to threading semantics. + * </p> + * + * @see org.netbeans.api.queries.IndexabilityQuery + * @since org.netbeans.modules.parsing.indexing 9.22.0 + */ +public interface IndexabilityQueryImplementation { + + /** + * Determine if the supplied file object should be indexed. + * + * @param fo file object to be indexed + * @return true if indexing should be prevented + */ + default boolean preventIndexing(FileObject fo) { + return false; + } + + /** + * Determine if the supplied indexable should be indexed using the given + * indexer (identified either by the name of the indexer or its factory + * class). + * + * @param indexerName name of the indexer that will be invoked on the + * indexable + * @param factoryClassName class name of the factory for the indexer that + * will be invoked on the indexable + * @param indexable the file that is about to be indexed + * @param rootUrl the root of the index process, can be {@code null} + * @return + */ + default boolean preventIndexing(String indexerName, String factoryClassName, URL indexable, URL rootUrl) { Review comment: Factory class name of indexers becomes an API! Weird. ########## File path: ide/parsing.indexing/src/org/netbeans/modules/parsing/impl/indexing/FilteringIterable.java ########## @@ -0,0 +1,84 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.netbeans.modules.parsing.impl.indexing; + +import java.util.Iterator; +import java.util.NoSuchElementException; +import java.util.function.Function; + +/** + * Iterable wrapping another iterable, yielding an interator, that only offers + * values, for this the supplied filter returns a true value. + */ +public class FilteringIterable<T> implements Iterable<T> { + private final Iterable<? extends T> delegate; + private final Function<T,Boolean> filter; + + public FilteringIterable(Iterable<? extends T> delegate, Function<T,Boolean> filter) { + this.delegate = delegate; + this.filter = filter; + } + + @Override + public Iterator<T> iterator() { + return new FilteringIterator(delegate.iterator(), filter); + } + +} + +class FilteringIterator<T> implements Iterator<T> { Review comment: Using inner class would be more typical NetBeans coding style, I guess. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected] For further information about the NetBeans mailing lists, visit: https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists
