es.iti.wakamiti.api.matcher.CharSequenceLengthMatcher Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wakamiti-api Show documentation
API for Wakamiti Plugins
The newest version!
/*
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */
package es.iti.wakamiti.api.matcher;


import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeMatcher;

import static org.hamcrest.Matchers.equalTo;


/**
 * Tests if the argument is a {@link CharSequence} that matches a specified
 * length.
 */
public class CharSequenceLengthMatcher extends TypeSafeMatcher {

    /**
     * Creates a matcher of {@link CharSequence} that matches when the examined
     * {@link CharSequence} has the length determined by the specified matcher.
     * 
     * For example:
     * 
assertThat("myStringOfNote", length(not(equalTo(10))))
     * assertThat("myStringOfNote", length(lessThan(15))))
     *
     * @param lengthMatcher the matcher to apply to the examined {@link CharSequence}
     */
    public static CharSequenceLengthMatcher length(Matcher lengthMatcher) {
        return new CharSequenceLengthMatcher(lengthMatcher);
    }

    /**
     * Creates a matcher of {@link CharSequence} that matches when the examined
     * {@link CharSequence} has the specified length.
     * 
     * For example:
     * 
assertThat("myStringOfNote", length(10))
     *
     * @param length the length that the returned matcher will expect any
     *               examined string to have
     */
    public static CharSequenceLengthMatcher length(int length) {
        return length(equalTo(length));
    }

    private final Matcher lengthMatcher;

    public CharSequenceLengthMatcher(Matcher lengthMatcher) {
        this.lengthMatcher = lengthMatcher;
    }

    @Override
    protected boolean matchesSafely(CharSequence text) {
        return lengthMatcher.matches(text != null ? text.length() : 0);
    }

    @Override
    public void describeMismatchSafely(CharSequence item, Description mismatchDescription) {
        mismatchDescription.appendText("was length \"").appendText(item == null ? null : String.valueOf(item.length())).appendText("\"");
    }

    @Override
    public void describeTo(Description description) {
        description.appendText("has string length ").appendDescriptionOf(lengthMatcher);
    }
}