001// Copyright 2010-2013 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007// http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry5.services.javascript;
016
017import org.apache.tapestry5.ioc.annotations.UsesMappedConfiguration;
018import org.apache.tapestry5.ioc.util.UnknownValueException;
019
020import java.util.List;
021
022/**
023 * Manages the available {@link JavaScriptStack}s, each of which has a unique name.
024 *
025 * @since 5.2.0
026 */
027@UsesMappedConfiguration(JavaScriptStack.class)
028public interface JavaScriptStackSource
029{
030    /**
031     * Gets a stack by name (ignoring case).
032     *
033     * @return named stack
034     * @throws UnknownValueException
035     *         if no such stack
036     */
037    JavaScriptStack getStack(String name);
038
039    /**
040     * Gets a stack by name (ignoring case).
041     *
042     * @return named stack, or null if not found
043     * @since 5.4
044     */
045    JavaScriptStack findStack(String name);
046
047    /**
048     * Returns the names of all stacks, in sorted order.
049     *
050     * @since 5.2.1
051     */
052    List<String> getStackNames();
053}