ide/editor.completion/src/org/netbeans/spi/editor/completion/CompositeCompletionItem.java

/*
 * 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.editor.completion;

import java.util.List;

/**
 * Interface representing a completion item containing possible sub-items.
 *
 * @author Dusan Balek
 * @since 1.38
 */
public interface CompositeCompletionItem extends CompletionItem {
    
    /**
     * Gets sub-items of the code completion item. The sub-items may be shown
     * as a sub-menu for the given item.
     * 
     * @return non-null list of sub-items.
     */
    List<? extends CompletionItem> getSubItems();
}