org.netbeans.spi.java.queries.AnnotationProcessingQueryImplementation Maven / Gradle / Ivy

Go to download
/*
 * 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.spi.java.queries;

import org.netbeans.api.java.queries.AnnotationProcessingQuery;
import org.netbeans.api.java.queries.AnnotationProcessingQuery.Result;
import org.openide.filesystems.FileObject;

/**SPI for the {@link AnnotationProcessingQuery}.
 *
 * @author Jan Lahoda
 * @since org.netbeans.api.java/1 1.25
 */
public interface AnnotationProcessingQueryImplementation {

    /**Return the annotation processing configuration, or null if the current
     * provider cannot provide configuration for the given file/folder.
     *
     * @param file Java source file, Java package or source folder in question
     * @return non-null Result if this provider can provide annotation processing configuration for the given file/folder.
     */
    public Result getAnnotationProcessingOptions(FileObject file);

}