Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||||
Predicate |
|
| 0.0;0 |
1 | /* |
|
2 | * Licensed to the Apache Software Foundation (ASF) under one or more |
|
3 | * contributor license agreements. See the NOTICE file distributed with |
|
4 | * this work for additional information regarding copyright ownership. |
|
5 | * The ASF licenses this file to You under the Apache License, Version 2.0 |
|
6 | * (the "License"); you may not use this file except in compliance with |
|
7 | * the License. You may obtain a copy of the License at |
|
8 | * |
|
9 | * http://www.apache.org/licenses/LICENSE-2.0 |
|
10 | * |
|
11 | * Unless required by applicable law or agreed to in writing, software |
|
12 | * distributed under the License is distributed on an "AS IS" BASIS, |
|
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
14 | * See the License for the specific language governing permissions and |
|
15 | * limitations under the License. |
|
16 | */ |
|
17 | package org.apache.camel; |
|
18 | ||
19 | /** |
|
20 | * Evaluates a binary <a href="http://activemq.apache.org/camel/predicate.html">predicate</a> |
|
21 | * on the message exchange to support things like |
|
22 | * <a href="http://activemq.apache.org/camel/scripting-languages.html">scripting languages</a>, |
|
23 | * <a href="http://activemq.apache.org/camel/xquery.html">XQuery</a> |
|
24 | * or <a href="http://activemq.apache.org/camel/sql.html">SQL</a> as well |
|
25 | * as any arbitrary Java expression. |
|
26 | * |
|
27 | * @version $Revision: 532316 $ |
|
28 | */ |
|
29 | public interface Predicate<E> { |
|
30 | ||
31 | /** |
|
32 | * Evaluates the predicate on the message exchange and returns true |
|
33 | * if this exchange matches the predicate |
|
34 | * |
|
35 | * @param exchange the message exchange |
|
36 | * @return true if the predicate matches |
|
37 | */ |
|
38 | boolean matches(E exchange); |
|
39 | ||
40 | /** |
|
41 | * Allows this predicate to be used nicely in testing to generate |
|
42 | * a nicely formatted exception and message if this predicate does not |
|
43 | * match for the given exchange. |
|
44 | * |
|
45 | * @param text the description to use in the exception message |
|
46 | * @param exchange the exchange to evaluate the expression on |
|
47 | * @throws AssertionError if the predicate does not match |
|
48 | */ |
|
49 | void assertMatches(String text, E exchange) throws AssertionError; |
|
50 | ||
51 | } |