• Home
• org.daisy.streamline
• streamline-api
• 1.6.0
• source code
• Validator.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.daisy.streamline.api.validity.Validator Maven / Gradle / Ivy

package org.daisy.streamline.api.validity;

import java.net.URL;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import org.daisy.streamline.api.media.InputStreamSupplier;
import org.daisy.streamline.api.option.UserOption;

/**
 * Provides an interface for validators
 * @author Joel Håkansson
 */
public interface Validator {
	
	/**
	 * Validates the resource at the given URL.
	 * @param input the resource URL
	 * @return returns the validation report
	 */
	public default ValidationReport validate(URL input) {
		return validate(input, Collections.emptyMap());
	}
	
	/**
	 * Validates the resource at the given URL.
	 * @param input the resource URL
	 * @param options the validation options
	 * @return returns the validation report
	 */
	public ValidationReport validate(URL input, Map options);
	
	/**
	 * Validates the given resource.
	 * @param input the resource
	 * @return returns the validation report
	 */
	public default ValidationReport validate(InputStreamSupplier input) {
		return validate(input, Collections.emptyMap());
	}
	
	/**
	 * Validates the given resource.
	 * @param input the resource
	 * @param options the validation options
	 * @return returns the validation report
	 */
	public ValidationReport validate(InputStreamSupplier input, Map options);

	/**
	 * Gets a list of parameters applicable to this instance
	 * @return returns a list of parameters
	 */
	public default List listOptions() {
		return Collections.emptyList();
	}

}