com.adobe.aemds.guide.service.WebFontService Maven / Gradle / Ivy

Go to download
/*
 * **********************************************************************
 *  ADOBE CONFIDENTIAL
 *  __________________
 *
 *  Copyright 2016 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 *  NOTICE:  All information contained herein is, and remains
 *  the property of Adobe Systems Incorporated and its suppliers,
 *  if any.  The intellectual and technical concepts contained
 *  herein are proprietary to Adobe Systems Incorporated and its
 *  suppliers and may be covered by U.S. and Foreign Patents,
 *  patents in process, and are protected by trade secret or copyright law.
 *  Dissemination of this information or reproduction of this material
 *  is strictly forbidden unless prior written permission is obtained
 *  from Adobe Systems Incorporated.
 *  **********************************************************************
 */
package com.adobe.aemds.guide.service;

import java.util.List;
import java.util.Set;

/**
 * Service framework for using any web font service.
 * @pad.exclude Exclude from Published API.
 */
public interface WebFontService {

    /**
     * Gets a list of fonts that are made available by the web font service.
     *
     * @param themePath The path to jcr:content node of theme on which the service is configured.
     * @return A list of string where each string represents a font provided by web font service.

     * Format for string representing font: font-name=font-family-value

     * Ex. A font named "XXXX" with font-family value "YYYY" will look like "XXXX=YYYY"
     */
    public List getFontList(String themePath);

    /**
     * It should return a string containing the html code (script tag or link tag) required
     * for using the web font service.
     *
     * @param themePath The path to jcr:content node of theme on which the service is configured.
     * @param usedFonts A set of all (not specific to the web font service) font-family values which are being used
     *                  in form or theme.
     * @return The html embed code (script tag or link tag) required for using the web font service. Empty String if invalid parameters are passed.
     */
    public String getEmbeddingCode(String themePath, Set usedFonts);
}