org.assertj.swing.util.StringTextMatcher Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of assertj-swing Show documentation
Assertj-Swing test framework
The newest version!
/*
 * 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.
 *
 * Copyright 2012-2018 the original author or authors.
 */
package org.assertj.swing.util;

import static org.assertj.core.util.Preconditions.checkNotNull;
import static org.assertj.core.util.Preconditions.checkNotNullOrEmpty;
import static org.assertj.core.util.Strings.quote;
import static org.assertj.swing.util.Arrays.format;
import static org.assertj.swing.util.Strings.areEqualOrMatch;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * Matches text to a group of {@code String} values. Matching is perform by equality or by regular expression matching.
 * 
 * @author Alex Ruiz
 */
public class StringTextMatcher implements TextMatcher {
  private final String[] values;

  /**
   * Creates a new {@link StringTextMatcher}.
   * 
   * @param values the {@code String} values to match. Each value can be a regular expression.
   * @throws NullPointerException if the array of values is {@code null}.
   * @throws IllegalArgumentException if the array of values is empty.
   */
  public StringTextMatcher(@NotNull String... values) {
    this.values = checkNotNullOrEmpty(values);
  }

  /**
   * Indicates whether the given text matches the {@code String} values in this matcher. Each value can be a regular
   * expression.
   * 
   * @param text the text to verify.
   * @return {@code true} if the given text matches the {@code String} values in this matcher, {@code false} otherwise.
   */
  @Override
  public boolean isMatching(@Nullable String text) {
    for (String value : values) {
      if (areEqualOrMatch(value, text)) {
        return true;
      }
    }
    return false;
  }

  /**
   * @return "value" if this matcher contains only one value, or "values" if this matcher contains more than one value.
   */
  @Override
  @NotNull
  public String description() {
    return onlyOneValue() ? "value" : "values";
  }

  /**
   * @return the {@code String} values in this matcher, formatted as a single {@code String}.
   */
  @Override
  @NotNull
  public String formattedValues() {
    String s = onlyOneValue() ? quote(values[0]) : format(values);
    return checkNotNull(s);
  }

  private boolean onlyOneValue() {
    return values.length == 1;
  }
}