io.kestros.commons.uilibraries.api.models.FrontendLibrary Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kestros-sling-ui-libraries-api Show documentation

Provides UI Libraries to Sling instances, which are used for maintaining and rendering CSS and JavaScript.

The newest version!

/*
 * 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 io.kestros.commons.uilibraries.api.models;

import java.util.List;
import javax.annotation.Nonnull;
import org.apache.sling.api.resource.Resource;

/**
 * Baseline interface for frontend libraries, which can render CSS and JavaScript.
 */
public interface FrontendLibrary {

  /**
   * Library Resource.
   *
   * @return Library Resource.
   */
  @Nonnull
  Resource getResource();

  /**
   * Library title.
   *
   * @return Library title.
   */
  @Nonnull
  String getTitle();

  /**
   * Library description.
   *
   * @return Library description.
   */
  @Nonnull
  String getDescription();

  /**
   * Library shorthand name.
   *
   * @return Library shorthand name.
   */
  @Nonnull
  String getName();

  /**
   * Path to library resource.
   *
   * @return Path to library resource.
   */
  @Nonnull
  String getPath();

  /**
   * Path to CSS endpoint.
   *
   * @return Path to CSS endpoint.
   */
  @Nonnull
  String getCssPath();

  /**
   * Path to JavaScript endpoint.
   *
   * @return Path to JavaScript endpoint.
   */
  @Nonnull
  String getJsPath();

  /**
   * Files to include, for a specified script type.
   *
   * @param scriptType ScriptType
   * @return Files to include, for a specified script type.
   */
  @Nonnull
  List getIncludedFileNames(@Nonnull ScriptType scriptType);

  /**
   * Included script files.
   *
   * @param scriptTypes Script types to retrieve.
   * @param folderName Folder to retrieve scripts from.
   * @param  extends {@link ScriptFile}.
   * @return Included script files.
   */
  @Nonnull
   List getScriptFiles(@Nonnull final List scriptTypes,
      @Nonnull String folderName);
}