it.tidalwave.netbeans.role.provider.RoleProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of it-tidalwave-netbeans-capabilitiesprovider Show documentation
The newest version!
/***********************************************************************************************************************
 *
 * OpenBlueSky - NetBeans Platform Enhancements
 * Copyright (C) 2006-2012 by Tidalwave s.a.s. (http://www.tidalwave.it)
 *
 ***********************************************************************************************************************
 *
 * Licensed 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.
 *
 ***********************************************************************************************************************
 *
 * WWW: http://openbluesky.java.net
 * SCM: https://bitbucket.org/tidalwave/openbluesky-src
 *
 **********************************************************************************************************************/
package it.tidalwave.netbeans.role.provider;

import javax.annotation.Nonnull;
import javax.annotation.concurrent.ThreadSafe;
import java.util.Collection;
import org.openide.util.Lookup;
import it.tidalwave.netbeans.capabilitiesprovider.*;

/***********************************************************************************************************************
 *
 * This class is a factory that provides roles that should be put into a object {@link Lookup}.
 * Contents can be expressed both as simple objects (that will be wrapped into a fixed {@code Lookup}) and as pre-filled
 * (or custom-written) {@code Lookup}s in case some specific behaviour is needed.
 *
 * It's preferrable for you not to directly implement this interface, rather subclass
 * {@link RoleProviderSupport}. See javadoc of the latter class for an example. In order for the managed object
 * to retrieve its {@code Lookup}, you should use {@link LookupFactory}.
 *
 * @author  Fabrizio Giudici
 * @version $Id$
 *
 **********************************************************************************************************************/
@ThreadSafe
public interface RoleProvider 
  {
    /*******************************************************************************************************************
     *
     * Return the managed object class.
     * 
     * @return              the managed class
     *
     ******************************************************************************************************************/
    @Nonnull
    public Class getOwnerClass();
    
    /*******************************************************************************************************************
     *
     * Provides roles for the managed object as a collection of plain objects.
     * 
     * @param  owner        the owner
     * @return              the roles
     *
     ******************************************************************************************************************/
    @Nonnull
    public Collection createRoles (@Nonnull T owner);
    
    /*******************************************************************************************************************
     *
     * Provides roles for the managed object as {@link Lookup} instances.
     * 
     * @param  owner        the owner
     * @return              the Lookups
     *
     ******************************************************************************************************************/
    @Nonnull
    public Collection createLookups (@Nonnull T owner);
  }