DependencyDescription.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.apache.felix.ipojo.handlers.dependency;

import java.util.Comparator;
import java.util.List;

import org.apache.felix.ipojo.util.DependencyModelListener;
import org.osgi.framework.Filter;
import org.osgi.framework.ServiceReference;

/**
 * Service Dependency Description.
 * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
 */
public class DependencyDescription {
    /**
     * The described dependency.
     */
    private final Dependency m_dependency;

    /**
     * Creates a dependency description.
     * @param dep the described dependency
     */
    public DependencyDescription(Dependency dep) {
        m_dependency = dep;
    }

    public boolean isMultiple() { return m_dependency.isAggregate(); }

    public boolean isOptional() { return m_dependency.isOptional(); }

    public String getFilter() { return m_dependency.getFilter(); }

    public String getInterface() { return m_dependency.getSpecification().getName(); }

    public int getState() { return m_dependency.getState(); }
    
    public String getId() { return m_dependency.getId(); }
    
    public boolean isProxy() { return m_dependency.isProxy(); }

    
    /**
     * Gets <code>true</code> if the dependency uses Nullable objects.
     * @return true if the dependency is optional and supports nullable object.
     */
    public boolean supportsNullable() { return m_dependency.supportsNullable(); }
    
    public String getDefaultImplementation() { return m_dependency.getDefaultImplementation(); }
    
    public int getPolicy() { return m_dependency.getBindingPolicy(); }
    
    public String getComparator() { return m_dependency.getComparator(); }
    
    public boolean isFrozen() { return m_dependency.isFrozen(); }

    /**
     * Gets the service reference list.
     * @return the list of matching service reference,
     * <code>null</code> if no service reference.
     */
    public List<ServiceReference> getServiceReferences() { return m_dependency.getServiceReferencesAsList(); }

    /**
     * Gets the service reference if only one service reference is used.
     * @return the ServiceReference (only if the cardinality could be 1),
     * or <code>null</code> if no service reference.
     */
    public ServiceReference getServiceReference() { 
        List list = getServiceReferences();
        if (list == null) {
            return null;
        } else {
            return (ServiceReference) list.get(0);
        }
    }

    /**
     * Gets the used service set.
     * @return the list [service reference] containing the used services,
     * <code>null</code> if no providers are used
     */
    public List<ServiceReference> getUsedServices() { return m_dependency.getUsedServiceReferences(); }
    
    /**
     * Sets the dependency comparator.
     * The reference set will be sort at the next usage.
     * @param cmp the comparator
     */
    public void setComparator(Comparator cmp) {
        m_dependency.setComparator(cmp);
    }
    
    /**
     * Sets the dependency filter.
     * @param filter the new LDAP filter
     */
    public void setFilter(Filter filter) {
        m_dependency.setFilter(filter);
    }
    
    /**
     * Sets the dependency cardinality.
     * @param isAgg if <code>true</code> sets the dependency to aggregate,
     * if <code>false</code> sets the dependency to scalar.
     */
    public void setAggregate(boolean isAgg) {
        m_dependency.setAggregate(isAgg);
    }
    
    /**
     * Sets the dependency optionality.
     * @param isOpt if <code>true</code> sets the dependency to optional,
     * if <code>false</code> sets the dependency to mandatory.
     */
    public void setOptional(boolean isOpt) {
        m_dependency.setOptionality(isOpt);
    }

    /**
     * Gets the required service specification name.
     * @return the required service specification class name.
     */
    public String getSpecification() {
        return m_dependency.getSpecification().getName();
    }

    /**
     * Gets the described dependency.
     * @return the dependency.
     */
    public Dependency getDependency() {
        return m_dependency;
    }

    /**
     * Add the given listener to the dependency model's list of listeners.
     *
     * @param listener the {@code DependencyModelListener} object to be added
     * @throws NullPointerException if {@code listener} is {@code null}
     */
    public void addListener(DependencyModelListener listener) {
        m_dependency.addListener(listener);
    }

    /**
     * Remove the given listener from the dependency model's list of listeners.
     *
     * @param listener the {@code DependencyModelListener} object to be removed
     * @throws NullPointerException if {@code listener} is {@code null}
     * @throws java.util.NoSuchElementException if {@code listener} wasn't present in the dependency model's list of listeners
     */
    public void removeListener(DependencyModelListener listener) {
        m_dependency.removeListener(listener);
    }
}