org.tinymediamanager.scraper.mediaprovider.IMediaArtworkProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-scraper Show documentation

API for tinyMediaManager scrapers

There is a newer version: 3.0.5

/*
 * Copyright 2012 - 2019 Manuel Laggner
 *
 * Licensed 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.tinymediamanager.scraper.mediaprovider;

import java.util.List;

import org.tinymediamanager.scraper.MediaScrapeOptions;
import org.tinymediamanager.scraper.entities.MediaArtwork;
import org.tinymediamanager.scraper.exceptions.MissingIdException;
import org.tinymediamanager.scraper.exceptions.ScrapeException;

/**
 * The Interface {@link IMediaArtworkProvider}. All media providers for Artwork must implement this interface
 * 
 * @author Manuel Laggner
 * @since 3.0
 */
public interface IMediaArtworkProvider extends IMediaProvider {

  /**
   * Gets the artwork.
   * 
   * @param options
   *          the options
   * @return the artwork
   * @throws ScrapeException
   *           any exception which can be thrown while scraping
   * @throws MissingIdException
   *           indicates that there was no usable id to scrape
   */
  List getArtwork(MediaScrapeOptions options) throws ScrapeException, MissingIdException;
}