org.openide.nodes.DestroyableNodesFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org-openide-nodes 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.openide.nodes;

/**
 * Subclass of {@link ChildFactory.Detachable} with lifecycle method invoked when
 * nodes created by the factory are no longer needed.
 *
 * @param  The key type for this child factory
 * @since org.openide.nodes 7.45
 */
public abstract class DestroyableNodesFactory extends ChildFactory.Detachable {

    /**
     * Called when nodes created previously by this factory are no longer
     * present in the node hierarchy.
     *
     * @param arr nodes which are no longer needed
     */
    @Override
    protected void destroyNodes(Node[] arr) {
        //do nothing
    }
    
}