01 /*
02 * Java Genetic Algorithm Library (jenetics-7.1.0).
03 * Copyright (c) 2007-2022 Franz Wilhelmstötter
04 *
05 * Licensed under the Apache License, Version 2.0 (the "License");
06 * you may not use this file except in compliance with the License.
07 * You may obtain a copy of the License at
08 *
09 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 * Author:
18 * Franz Wilhelmstötter (franz.wilhelmstoetter@gmail.com)
19 */
20 package io.jenetics.ext.internal.parser;
21
22 import java.util.Objects;
23 import java.util.stream.Stream;
24
25 /**
26 * Interface for all tokenizers.
27 *
28 * @param <T> the token value type
29 *
30 * @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
31 * @since 7.1
32 * @version 7.1
33 */
34 @FunctionalInterface
35 public interface Tokenizer<T> {
36
37 /**
38 * Return the next available <em>token</em>, or {@code null} if no further
39 * tokens are available.
40 *
41 * @return the next available token
42 */
43 T next();
44
45 /**
46 * Return a stream of tokens, generated by {@code this} tokenizer. The
47 * returned stream terminates, when the {@code null}-token is encountered.
48 *
49 * @return a new tokens stream of {@code this} tokenizer
50 */
51 default Stream<T> tokens() {
52 return Stream.generate(this::next).takeWhile(Objects::nonNull);
53 }
54
55 }
|