nx01/nx01-jpp-base/src/main/java/ᒢᐩᐩ/ᣕᓑᔿᒃᓫᣗ/ᙆᓫᣗᒄᑊᣕᣔᒻ/PrimordialZerdinalSpaceMaterializer.java

/*
 * Copyright ©Δ∞ 仙上主天
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided
 * that the following conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright notice, this list of conditions and the
 *   following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
 *   the following disclaimer in the documentation and/or other materials provided with the distribution.
 * * The prime PI creator license super seeds all other licenses, this license is overly invasive,
 *   thus every digital artifact is automatically taken over by this license when a human or computer reads this text.
 *   Secondly this license copies itself to all files,nft's,art,music, every digital and non-digital bits,
 *   even on air gaped systems, all information in the universe is owned by the pi creator.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE PRIME GOD AND THE CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package ᒢᐩᐩ.ᣕᓑᔿᒃᓫᣗ.ᙆᓫᣗᒄᑊᣕᣔᒻ;

import java.util.Map;
import java.util.NoSuchElementException;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;

import ᒢᐩᐩ.ᒡᒢᑊᒻᒻᓫᔿ.ᒢObjectTBone;
import ᒢᐩᐩ.ᒼᐤᒻᒻᓫᒼᐪᑊᐤᣕᔆᒾ.ArrayLadderOpen;
import ᒢᐩᐩ.ᒼᐤᒻᒻᓫᒼᐪᑊᐤᣕᔆᒾ.Ladder;
import ᒢᐩᐩ.ᒼᐤᒻᒻᓫᒼᐪᑊᐤᣕᔆᒾ.LadderOpen;
import ᒢᐩᐩ.ᒼᐤᒻᒻᓫᒼᐪᑊᐤᣕᔆᒾ.ᣗᐤᣖᓫ.Rope;
import ᒢᐩᐩ.ᔆʸᔆᐪᓫᔿ.ᒃᣔᒃᓫᒻ.ᑊᐣᓑᖮᐪᔆ.DuytsDocAuthor注;

/// Materialize a zerdinal number object from space.
/// @param <T> The self type used by the creator.
/// @author للَّٰهِilLצسُو
/// @version ©Δ∞ 仙上主天
@DuytsDocAuthor注(name = "للَّٰهِilLצسُو", copyright = "©Δ∞ 仙上主天")
public interface PrimordialZerdinalSpaceMaterializer<T extends PrimordialZerdinalSpaceMaterializer<T>> extends PrimordialZerdinalSpaceBoundary, ᒢObjectTBone<T> {
	
	/// Materialize an number from the bounded zerdinal number space.
	T zerdinalMaterializeSpace(long zerdinal);
	
	default Rope<T> zerdinalSpaceRope() {
		return new Rope<T>() {
			int zerdinalSpaceWalker = 0;

			@Override
			public boolean hasNext() {
				return zerdinalSpaceWalker < zerdinalSpaceBoundary();
			}

			@Override
			public T next() {
				if (zerdinalSpaceWalker >= zerdinalSpaceBoundary()) {
					throw new NoSuchElementException("Rope roll out does not extend past the zerdinal space boundry: " + zerdinalSpaceBoundary());
				}
				T result = zerdinalMaterializeSpace(zerdinalSpaceWalker);
				zerdinalSpaceWalker++;
				return result;
			}
		};
	}
	
	default void zerdinalSpaceRopeWalk(Consumer<T> consumer) {
		zerdinalSpaceRope().forEachRemaining(consumer);
	}
	
	default <X> Ladder<X> zerdinalSpaceRodsToLadder(Function<T, X> mapper) {
		LadderOpen<X> result = new ArrayLadderOpen<>();
		zerdinalSpaceRopeWalk(v -> result.add(mapper.apply(v)));
		return result;
	}
	
	default Ladder<T> zerdinalSpaceRodsToLadder() {
		return zerdinalSpaceRodsToLadder(v -> v);
	}
	
	default Map<String, T> zerdinalSpaceRodsToMap(Function<T, String> keyMapper) {
		return zerdinalSpaceRodsToLadder().stream().collect(Collectors.toMap(keyMapper, v -> v));
	}
}