View Javadoc

1   /****************************************************************
2    * Licensed to the Apache Software Foundation (ASF) under one   *
3    * or more contributor license agreements.  See the NOTICE file *
4    * distributed with this work for additional information        *
5    * regarding copyright ownership.  The ASF licenses this file   *
6    * to you under the Apache License, Version 2.0 (the            *
7    * "License"); you may not use this file except in compliance   *
8    * with the License.  You may obtain a copy of the License at   *
9    *                                                              *
10   *   http://www.apache.org/licenses/LICENSE-2.0                 *
11   *                                                              *
12   * Unless required by applicable law or agreed to in writing,   *
13   * software distributed under the License is distributed on an  *
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
15   * KIND, either express or implied.  See the License for the    *
16   * specific language governing permissions and limitations      *
17   * under the License.                                           *
18   ****************************************************************/
19  
20  package org.apache.jsieve.comparators;
21  
22  import org.apache.jsieve.exception.FeatureException;
23  
24  
25  /**
26   * Interface Contains defines the method signatures for contains comparators.
27   */
28  public interface Contains {
29  
30      /**
31       * Method contains answers a <code>boolean</code> indicating if parameter
32       * <code>container</code> contains parameter <code>content</code> using
33       * the comparison rules defind by the implementation.
34       * 
35       * @param container
36       * @param content
37       * @return boolean
38       * @throws FeatureException when substring is unsupported
39       */
40      public boolean contains(String container, String content) throws FeatureException;
41  
42  }