framework/src/java/org/apache/tapestry/spec/ILibrarySpecification.java

// Copyright 2004, 2005 The Apache Software Foundation
//
// 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.

package org.apache.tapestry.spec;

import java.util.List;
import java.util.Map;

import org.apache.hivemind.LocationHolder;
import org.apache.hivemind.Resource;
import org.apache.tapestry.util.IPropertyHolder;

/**
 * Interface for the Specification for a library.
 * {@link org.apache.tapestry.spec.ApplicationSpecification}is a specialized kind of library.
 * 
 * @author Geoffrey Longman
 * @since 2.2
 */

public interface ILibrarySpecification extends IPropertyHolder, LocationHolder
{

    /**
     * Returns the specification path (within the classpath) for an embedded library, or null if no
     * such library has been defined.
     */

    public String getLibrarySpecificationPath(String id);

    /**
     * Sets the specification path for an embedded library.
     * 
     * @throws IllegalArgumentException
     *             if a library with the given id already exists
     */

    public void setLibrarySpecificationPath(String id, String path);

    /**
     * Returns a sorted list of library ids (or the empty list, but not null).
     */

    public List getLibraryIds();

    public String getPageSpecificationPath(String name);

    public void setPageSpecificationPath(String name, String path);

    /**
     * Returns a sorted list of page names explicitly defined by this library, or an empty list (but
     * not null).
     */

    public List getPageNames();

    public void setComponentSpecificationPath(String type, String path);

    public String getComponentSpecificationPath(String type);

    /**
     * Returns the simple types of all components defined in this library. Returns a list of strings
     * in sorted order, or an empty list (but not null).
     * 
     * @since 3.0
     */

    public List getComponentTypes();

    /**
     * @throws UnsupportedOperationException always
     * @deprecated to be removed in release 4.1
     */
    
    public String getServiceClassName(String name);

    /**
     * Returns a sorted list of service names (or an empty list, but not null).
     * 
     * @returns an empty list (as of release 4.0)
     * @deprecated to be removed in release 4.1
     */

    public List getServiceNames();

    /**
     * @deprecated To be removed in release 4.1.
     * @throws UnsupportedOperationException always
     */
    public void setServiceClassName(String name, String className);

    /**
     * Returns the documentation for this library..
     */

    public String getDescription();

    /**
     * Sets the documentation for this library.
     */

    public void setDescription(String description);

    /**
     * Returns a Map of extensions; key is extension name, value is
     * {@link org.apache.tapestry.spec.IExtensionSpecification}. May return null. The returned Map
     * is immutable.
     */

    public Map getExtensionSpecifications();

    /**
     * Adds another extension specification.
     */

    public void addExtensionSpecification(String name, IExtensionSpecification extension);

    /**
     * Returns a sorted List of the names of all extensions. May return the empty list, but won't
     * return null.
     */

    public List getExtensionNames();

    /**
     * Returns the named IExtensionSpecification, or null if it doesn't exist.
     */

    public IExtensionSpecification getExtensionSpecification(String name);

    /**
     * Returns an instantiated extension. Extensions are created as needed and cached for later use.
     * 
     * @throws IllegalArgumentException
     *             if no extension specification exists for the given name.
     */

    public Object getExtension(String name);

    /**
     * Returns an instantiated extension, performing a check to ensure that the extension is a
     * subtype of the given class (or extends the given interface).
     * 
     * @throws IllegalArgumentException
     *             if no extension specification exists for the given name, or if the extension
     *             fails the type check.
     * @since 3.0
     */

    public Object getExtension(String name, Class typeConstraint);

    /**
     * Returns true if the named extension exists (or can be instantiated), returns false if the
     * named extension has no specification.
     */

    public boolean checkExtension(String name);

    /**
     * Invoked after the entire specification has been constructed to instantiate any extensions
     * marked immediate.
     */

    public void instantiateImmediateExtensions();

    public String getPublicId();

    public void setPublicId(String value);

    /**
     * Returns the location from which the specification was read.
     * 
     * @since 3.0
     */

    public Resource getSpecificationLocation();

    /** @since 3.0 * */

    public void setSpecificationLocation(Resource specificationLocation);
}