org.netbeans.modules.project.libraries.DefaultLibraryImplementation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org-netbeans-modules-project-libraries 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.modules.project.libraries;

import java.net.URL;
import java.util.*;
import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeEvent;
import java.text.MessageFormat;
import org.netbeans.api.annotations.common.CheckForNull;
import org.netbeans.api.annotations.common.NonNull;
import org.netbeans.api.annotations.common.NullAllowed;
import org.netbeans.spi.project.libraries.LibraryImplementation3;
import org.openide.util.Parameters;

public final class DefaultLibraryImplementation implements LibraryImplementation3 {

    private String description;

    private Map> contents;

    // library 'binding name' as given by user
    private String name;

    private String libraryType;

    private String localizingBundle;

    private String displayName;

    private List listeners;
    
    private volatile Map properties = Collections.emptyMap();

    /**
     * Create new LibraryImplementation supporting given library.
     */
    public DefaultLibraryImplementation (
            @NonNull final String libraryType,
            @NonNull final String[] volumeTypes) {
        Parameters.notNull("libraryType", libraryType); //NOI18N
        Parameters.notNull("volumeTypes", volumeTypes); //NOI18N
        this.libraryType = libraryType;
        this.contents = new HashMap>();
        for (String vtype : volumeTypes) {
            Parameters.notNull("volumeTypes", vtype);   //NOI18N
            this.contents.put(vtype, Collections.emptyList());
        }
    }


    @Override
    public String getType() {
        return libraryType;
    }

    @Override
    public void setName(final String name) throws UnsupportedOperationException {
        String oldName = this.name;
        this.name = name;
        this.firePropertyChange (PROP_NAME, oldName, this.name);
    }

    @Override
    public String getName() {
        return name;
    }

    @Override
    public List getContent(String contentType) throws IllegalArgumentException {
        List content = contents.get(contentType);
        if (content == null) {
            throw new IllegalArgumentException (
                    MessageFormat.format(
                        "Volume: {0} is not support by this library. The only acceptable values are: {1}",  //NOI18N
                        contentType,
                        contents.keySet()
                        ));
        }
        return Collections.unmodifiableList (content);
    }

    @Override
    public void setContent(String contentType, List path) throws IllegalArgumentException {
        if (path == null) {
            throw new IllegalArgumentException ();
        }
        if (this.contents.containsKey(contentType)) {
            this.contents.put(contentType, new ArrayList(path));
            this.firePropertyChange(PROP_CONTENT,null,null);
        } else {
            throw new IllegalArgumentException (
                    MessageFormat.format(
                        "Volume: {0} is not support by this library. The only acceptable values are: {1}",  //NOI18N
                        contentType,
                        contents.keySet()
                        ));
        }
    }

    @Override
    public String getDescription () {
            return this.description;
    }

    @Override
    public void setDescription (String text) {
        String oldDesc = this.description;
        this.description = text;
        this.firePropertyChange (PROP_DESCRIPTION, oldDesc, this.description);
    }

    @Override
    public String getLocalizingBundle() {
        return this.localizingBundle;
    }

    @Override
    public void setLocalizingBundle(String resourceName) {
        this.localizingBundle = resourceName;
    }

    @Override
    public @CheckForNull String getDisplayName() {
        return this.displayName;
    }

    @Override
    public void setDisplayName(final @NullAllowed String displayName) {
        final String oldDisplayName = this.displayName;
        this.displayName = displayName;
        this.firePropertyChange (PROP_DISPLAY_NAME, oldDisplayName, this.displayName);
    }

    @Override
    public synchronized void addPropertyChangeListener (PropertyChangeListener l) {
        if (this.listeners == null)
            this.listeners = new ArrayList();
        this.listeners.add (l);
    }

    @Override
    public synchronized void removePropertyChangeListener (PropertyChangeListener l) {
        if (this.listeners == null)
            return;
        this.listeners.remove (l);
    }

    @Override
    public String toString() {
        return "DefaultLibraryImplementation[" + name + "]"; // NOI18N
    }

    @Override
    public boolean equals (final Object other) {
        if (other instanceof DefaultLibraryImplementation) {
            final DefaultLibraryImplementation otherLib = (DefaultLibraryImplementation) other;
            return (name == null ? otherLib.name == null : name.equals(otherLib.name)) &&
                   (libraryType == null ? otherLib.libraryType == null : libraryType.equals(otherLib.libraryType));
        }
        return false;
    }

    @Override
    public int hashCode() {
        int hash = 31;
        hash = hash*17 + (name == null? 0 : name.hashCode());
        hash = hash*17 + (libraryType == null ? 0 : libraryType.hashCode());
        return hash;
    }

    private void firePropertyChange (String propName, Object oldValue, Object newValue) {
        List ls;
        synchronized (this) {
            if (this.listeners == null)
                return;
            ls = new ArrayList(listeners);
        }
        PropertyChangeEvent event = new PropertyChangeEvent (this, propName, oldValue, newValue);
        for (PropertyChangeListener l : ls) {
            l.propertyChange(event);
        }
    }

    @NonNull
    @Override
    public Map getProperties() {
        return properties;
    }
    
    @Override
    public void setProperties(@NonNull final Map props) {
        Parameters.notNull("props", props); //NOI18N
        final Map oldProps = properties;
        properties = new HashMap(props);
        firePropertyChange (PROP_PROPERTIES, oldProps, properties);
    }
}