org.netbeans.spi.extexecution.open.OptionOpenHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org-netbeans-modules-extexecution Show documentation

The newest version!

/*
 * 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.extexecution.open;

import org.netbeans.api.annotations.common.NonNull;
import org.netbeans.api.extexecution.ExecutionDescriptor;

/**
 * Defines a handler for options dialog opening. There has to be a handler
 * in the system for {@link ExecutionDescriptor#optionsPath(String)} in order
 * to work properly.
 * 
 * Module implementing this interface should be marked as providing
 * org.netbeans.spi.extexecution.open.OptionOpenHandler token.
 *
 * @author Petr Hejl
 * @since 1.33
 */
public interface OptionOpenHandler {

    /**
     * Opens the option dialog displaying options specified by the path.
     *
     * @param optionsPath the path describing options to display
     */
    void open(@NonNull String optionsPath);
}