001// Copyright 2011 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
017/**
018 * A contribution to an extensible {@link JavaScriptStack}. Such a stack is created in terms of all the contributions.
019 *
020 * @see ExtensibleJavaScriptStack
021 * @since 5.3
022 */
023public class StackExtension
024{
025    /**
026     * The type of extension.
027     */
028    public final StackExtensionType type;
029
030    /**
031     * The value contributed; will have symbols expanded, then be converted to the appropriate type.
032     */
033    public final String value;
034
035    public StackExtension(StackExtensionType type, String value)
036    {
037        this.type = type;
038        this.value = value;
039    }
040
041    @Override
042    public String toString()
043    {
044        return String.format("StackExtension[%s %s]", type.name(), value);
045    }
046
047    /**
048     * Convenience for defining a LIBRARY.
049     *
050     * @since 5.4
051     */
052    public static StackExtension library(String path)
053    {
054        return new StackExtension(StackExtensionType.LIBRARY, path);
055    }
056
057    /**
058     * Convenience for defining a MODULE.
059     *
060     * @since 5.4
061     */
062    public static StackExtension module(String name)
063    {
064        return new StackExtension(StackExtensionType.MODULE, name);
065    }
066
067    /**
068     * Convenience for defining a STYLESHEET.
069     *
070     * @since 5.4
071     */
072    public static StackExtension stylesheet(String path)
073    {
074        return new StackExtension(StackExtensionType.STYLESHEET, path);
075    }
076
077    /**
078     * Convenience for defining a STACK.
079     *
080     * @since 5.4
081     */
082    public static StackExtension stack(String name)
083    {
084        return new StackExtension(StackExtensionType.STACK, name);
085    }
086
087}