/*
 *
 *  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.royale.compiler.css;

import com.google.common.collect.ImmutableList;

/**
 * The root object of a CSS DOM. The CSS3 DOM objects serves not only IDE
 * features in code model, but also CSS compilation.
 */
public interface ICSSDocument extends ICSSNode
{
    /**
     * @return CSS rules in their declaration order.
     */
    ImmutableList<ICSSRule> getRules();

    /**
     * @return Namespace prefix declarations.
     */
    ImmutableList<ICSSNamespaceDefinition> getAtNamespaces();

    /**
     * @return Font face statements in their declaration order.
     */
    ImmutableList<ICSSFontFace> getFontFaces();

    /**
     * Get the {@link ICSSNamespaceDefinition} object from its associated prefix
     * name. 
     * 
     * @param prefix namespace prefix
     * @return {@code ICSSNamespaceDefinition} mapped to the given prefix.
     */
    ICSSNamespaceDefinition getNamespaceDefinition(String prefix);
    
    /**
     * Get the default {@link ICSSNamespaceDefinition} for this CSS document.
     * The default namespace's short name is an empty string {@code ""}. 
     */
    ICSSNamespaceDefinition getDefaultNamespaceDefinition();
}