ArchiveResourceSource.java

/*-
 * #%L
 * io.earcam.instrumental.archive
 * %%
 * Copyright (C) 2018 earcam
 * %%
 * SPDX-License-Identifier: (BSD-3-Clause OR EPL-1.0 OR Apache-2.0 OR MIT)
 * 
 * You <b>must</b> choose to accept, in full - any individual or combination of 
 * the following licenses:
 * <ul>
 * 	<li><a href="https://opensource.org/licenses/BSD-3-Clause">BSD-3-Clause</a></li>
 * 	<li><a href="https://www.eclipse.org/legal/epl-v10.html">EPL-1.0</a></li>
 * 	<li><a href="https://www.apache.org/licenses/LICENSE-2.0">Apache-2.0</a></li>
 * 	<li><a href="https://opensource.org/licenses/MIT">MIT</a></li>
 * </ul>
 * #L%
 */
package io.earcam.instrumental.archive;

import static io.earcam.instrumental.archive.ArchiveResourceSource.ResourceSourceLifecycle.INITIAL;

import java.util.Collection;
import java.util.stream.Stream;

/**
 * <p>
 * ArchiveResourceSource interface.
 * </p>
 *
 */
@FunctionalInterface
public interface ArchiveResourceSource {

	enum ResourceSourceLifecycle {
		INITIAL, PRE_MANIFEST, FINAL;
	}


	public static ArchiveResourceSource wrap(Collection<ArchiveResource> resources)
	{
		return s -> INITIAL.equals(s) ? resources.stream() : Stream.empty();
	}


	/**
	 * <p>
	 * Drain: resources must only be made available once.
	 * </p>
	 *
	 * @param stage the current construction stage
	 * @return the resources available at this stage
	 */
	Stream<ArchiveResource> drain(ResourceSourceLifecycle stage);
}