SkinAccessBridge.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.bridge;

import org.xwiki.component.annotation.Role;

/**
 * Exposes methods for accessing Skin data.
 * 
 * @version $Id: 6129a6f333fd3039f15447edc64ab2dfffbe4b69 $ 
 * @since 1.7
 */
@Role
public interface SkinAccessBridge
{
    /**
     * Gets a specific file from the current skin.
     * @param fileName the required file
     * @return the file's URL
     */
    String getSkinFile(String fileName);

    /**
     * @param iconName the standard name of an icon (it's not the name of the file on the filesystem, it's a generic
     *        name, for example "success" for a success icon
     * @return the URL to the icon resource
     * @since 2.6M1
     */
    String getIconURL(String iconName);
}