eu.cqse.check.framework.util.tokens.SequencePattern Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of teamscale-check-api Show documentation

The Teamscale Custom Check API allows users to extend Teamscale by writing custom analyses that create findings.

There is a newer version: 2024.7.2

/*
 * Copyright (c) CQSE GmbH
 *
 * 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.
 */

package eu.cqse.check.framework.util.tokens;

import java.util.Arrays;

import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * Tries to match the given subpatterns in order.
 */
public class SequencePattern extends TokenPatternBase {

	/** The patterns to match in order. */
	private final TokenPatternBase[] matchers;

	/** Constructor. */
	public SequencePattern(TokenPatternBase[] matchers) {
		this.matchers = matchers;
	}

	/** {@inheritDoc} */
	@Override
	protected @Nullable TokenPatternMatch matchesLocally(TokenStream stream) {
		TokenPatternMatch parentMatch = createMatch(stream);
		for (TokenPatternBase matcher : matchers) {
			TokenPatternMatch match = matcher.matches(stream);
			if (match == null) {
				return null;
			}
			parentMatch.mergeFrom(match);
		}
		return parentMatch;
	}

	/** {@inheritDoc} */
	@Override
	public String toString() {
		return "Sequence " + Arrays.toString(matchers);
	}
}