All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jenetics.internal.collection.Empty Maven / Gradle / Ivy

There is a newer version: 3.6.0
Show newest version
/*
 * Java Genetic Algorithm Library (jenetics-3.4.0).
 * Copyright (c) 2007-2016 Franz Wilhelmstötter
 *
 * 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.
 *
 * Author:
 *    Franz Wilhelmstötter ([email protected])
 */
package org.jenetics.internal.collection;

import static java.util.Objects.requireNonNull;

import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import java.util.Spliterator;
import java.util.Spliterators;
import java.util.function.Function;
import java.util.stream.Stream;

import org.jenetics.internal.util.require;

import org.jenetics.util.ISeq;
import org.jenetics.util.MSeq;

/**
 * Contains static {@code Seq} definitions.
 *
 * @author Franz Wilhelmstötter
 * @version 3.4
 * @since 3.4
 */
public final class Empty {

	private Empty() {require.noInstance();}

	/**
	 * Empty {@code MSeq} implementation.
	 */
	public static final MSeq MSEQ = new MSeq() {

		@Override
		public void set(final int index, final Object value) {
			throw new ArrayIndexOutOfBoundsException("MSeq is empty.");
		}

		@Override
		public ListIterator listIterator() {
			return asList().listIterator();
		}

		@Override
		public MSeq subSeq(final int start, final int end) {
			throw new ArrayIndexOutOfBoundsException("MSeq is empty.");
		}

		@Override
		public MSeq subSeq(final int start) {
			throw new ArrayIndexOutOfBoundsException("MSeq is empty.");
		}

		@Override
		public  MSeq map(final Function mapper) {
			requireNonNull(mapper);
			return mseq();
		}

		@Override
		public MSeq append(final Object... values) {
			return MSeq.of(values);
		}

		@Override
		public MSeq append(final Iterable values) {
			return MSeq.of(values);
		}

		@Override
		public MSeq prepend(final Object... values) {
			return MSeq.of(values);
		}

		@Override
		public MSeq prepend(final Iterable values) {
			return MSeq.of(values);
		}

		@Override
		public Stream stream() {
			return Stream.empty();
		}

		@Override
		public Stream parallelStream() {
			return Stream.empty();
		}

		@Override
		public Spliterator spliterator() {
			return Spliterators.emptySpliterator();
		}

		@Override
		public ISeq toISeq() {
			return ISEQ;
		}

		@Override
		public MSeq copy() {
			return this;
		}

		@Override
		public Object get(final int index) {
			throw new ArrayIndexOutOfBoundsException("MSeq is empty.");
		}

		@Override
		public int length() {
			return 0;
		}

		@Override
		public List asList() {
			return Collections.emptyList();
		}

		@Override
		public Iterator iterator() {
			return asList().iterator();
		}

	};


	/**
	 * Empty {@code ISeq} implementation.
	 */
	public static final ISeq ISEQ = new ISeq() {

		@Override
		public Iterator iterator() {
			return asList().iterator();
		}

		@Override
		public ISeq subSeq(final int start, final int end) {
			throw new ArrayIndexOutOfBoundsException("ISeq is empty.");
		}

		@Override
		public ISeq subSeq(final int start) {
			throw new ArrayIndexOutOfBoundsException("ISeq is empty.");
		}

		@Override
		public Object get(final int index) {
			throw new ArrayIndexOutOfBoundsException("ISeq is empty.");
		}

		@Override
		public int length() {
			return 0;
		}

		@Override
		public List asList() {
			return Collections.emptyList();
		}

		@Override
		public  ISeq map(final Function mapper) {
			requireNonNull(mapper);
			return iseq();
		}

		@Override
		public ISeq append(final Object... values) {
			return ISeq.of(values);
		}

		@Override
		public ISeq append(final Iterable values) {
			return ISeq.of(values);
		}

		@Override
		public ISeq prepend(final Object... values) {
			return ISeq.of(values);
		}

		@Override
		public ISeq prepend(final Iterable values) {
			return ISeq.of(values);
		}

		@Override
		public Stream stream() {
			return Stream.empty();
		}

		@Override
		public Stream parallelStream() {
			return Stream.empty();
		}

		@Override
		public Spliterator spliterator() {
			return Spliterators.emptySpliterator();
		}

		@Override
		public MSeq copy() {
			return MSEQ;
		}

	};

	@SuppressWarnings("unchecked")
	public static  MSeq mseq() {
		return (MSeq)MSEQ;
	}

	@SuppressWarnings("unchecked")
	public static  ISeq iseq() {
		return (ISeq)ISEQ;
	}

}