org.tinymediamanager.scraper.mediaprovider.IMediaProvider 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 org.tinymediamanager.scraper.MediaProviderInfo;

import net.xeoh.plugins.base.Plugin;

/**
 * The interface {@link IMediaProvider}. This is the root interface for all tinyMediaManager metadata provider interfaces You should not implement
 * this interface by a class, since plugin examination relies on the concrete interface
 *
 * @author Manuel Laggner
 * @since 1.0
 */
public interface IMediaProvider extends Plugin {
  /**
   * Gets a general information about the metadata provider
   * 
   * @return the provider info containing metadata of the provider
   */
  MediaProviderInfo getProviderInfo();

  /**
   * Method will be called, after ALL plugins have been loaded

   * This comes handy, when you need to initialize something depending on other plugins.
   */
  default void afterInitialization() {

  }
}