org.netbeans.api.java.source.RootsEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org-netbeans-modules-java-source-base 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.api.java.source;

import java.net.URL;
import java.util.EventObject;
import org.netbeans.api.java.classpath.ClassPath;

/**
 * Event used to notify the {@link ClassIndexListener} about
 * a change in  the underlying {@link ClassPath}
 * @author Tomas Zezula
 */
public final class RootsEvent extends EventObject {
    
    private final Iterable  roots;
    
    
    RootsEvent(final ClassIndex source, final Iterable roots) {
        super (source);
        assert roots != null;
        this.roots = roots;
    }
    
    /**
     * Returns the affected declared {@link ClassPath} roots.
     * @return an {@link Iterable} of {@link URL}
     */
    public Iterable getRoots () {
        return this.roots;
    }
    
    @Override
    public String toString () {
        return String.format ("RootsEvent [%s]",this.roots.toString());
    }
    
}