io.earcam.utilitarian.site.search.offline.Indexer Maven / Gradle / Ivy

/*-
 * #%L
 * io.earcam.utilitarian.site.search.offline
 * %%
 * Copyright (C) 2017 earcam
 * %%
 * SPDX-License-Identifier: (BSD-3-Clause OR EPL-1.0 OR Apache-2.0 OR MIT)
 * 
 * You must choose to accept, in full - any individual or combination of 
 * the following licenses:
 * 
 * 	BSD-3-Clause
 * 	EPL-1.0
 * 	Apache-2.0
 * 	MIT
 * 
 * #L%
 */
package io.earcam.utilitarian.site.search.offline;

import java.io.UncheckedIOException;
import java.util.stream.Stream;

public interface Indexer extends Component {

	public abstract Indexer add(Stream documents);


	/**
	 * Writes the Stringified index etc to whatever output
	 * the concrete indexer supports
	 *
	 * @throws UncheckedIOException if underlying IO throws checked
	 */
	public abstract void writeJson();
}