001/*
002 * Copyright 2002-2016 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.test.web.servlet.htmlunit;
018
019import com.gargoylesoftware.htmlunit.WebRequest;
020
021/**
022 * Strategy for matching on a {@link WebRequest}.
023 *
024 * @author Rob Winch
025 * @since 4.2
026 * @see org.springframework.test.web.servlet.htmlunit.HostRequestMatcher
027 * @see org.springframework.test.web.servlet.htmlunit.UrlRegexRequestMatcher
028 */
029public interface WebRequestMatcher {
030
031        /**
032         * Whether this matcher matches on the supplied web request.
033         * @param request the {@link WebRequest} to attempt to match on
034         * @return {@code true} if this matcher matches on the {@code WebRequest}
035         */
036        boolean matches(WebRequest request);
037
038}