001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase;
019
020import java.util.function.Supplier;
021import org.apache.yetus.audience.InterfaceAudience;
022import org.hamcrest.Description;
023import org.hamcrest.Matcher;
024import org.hamcrest.StringDescription;
025
026/**
027 * An implementation of {@link Waiter.ExplainingPredicate} that uses Hamcrest {@link Matcher} for
028 * both predicate evaluation and explanation.
029 *
030 * @param <T> The type of value to be evaluated via {@link Matcher}.
031 */
032@InterfaceAudience.Private
033public class MatcherPredicate<T> implements Waiter.ExplainingPredicate<RuntimeException> {
034
035  private final String reason;
036  private final Supplier<T> supplier;
037  private final Matcher<? super T> matcher;
038  private T currentValue;
039
040  public MatcherPredicate(final Supplier<T> supplier, final Matcher<? super T> matcher) {
041    this("", supplier, matcher);
042  }
043
044  public MatcherPredicate(final String reason, final Supplier<T> supplier,
045    final Matcher<? super T> matcher) {
046    this.reason = reason;
047    this.supplier = supplier;
048    this.matcher = matcher;
049    this.currentValue = null;
050  }
051
052  @Override public boolean evaluate() {
053    currentValue = supplier.get();
054    return matcher.matches(currentValue);
055  }
056
057  @Override public String explainFailure() {
058    final Description description = new StringDescription()
059      .appendText(reason)
060      .appendText("\nExpected: ").appendDescriptionOf(matcher)
061      .appendText("\n     but: ");
062    matcher.describeMismatch(currentValue, description);
063    return description.toString();
064  }
065}