io.jenetics.ext.internal.parser.Tokenizer Maven / Gradle / Ivy
The newest version!
/*
* Java Genetic Algorithm Library (jenetics-8.1.0).
* Copyright (c) 2007-2024 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 io.jenetics.ext.internal.parser;
import java.util.Objects;
import java.util.stream.Stream;
/**
* Interface for all tokenizers.
*
* @param the token value type
*
* @author Franz Wilhelmstötter
* @since 7.1
* @version 7.1
*/
@FunctionalInterface
public interface Tokenizer {
/**
* Return the next available token, or {@code null} if no further
* tokens are available.
*
* @return the next available token
*/
T next();
/**
* Return a stream of tokens, generated by {@code this} tokenizer. The
* returned stream terminates, when the {@code null}-token is encountered.
*
* @return a new tokens stream of {@code this} tokenizer
*/
default Stream tokens() {
return Stream.generate(this::next).takeWhile(Objects::nonNull);
}
}