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; 21 22 import org.apache.jsieve.comparators.Comparator; 23 import org.apache.jsieve.exception.LookupException; 24 25 /** 26 * <p>Maps Comparator names to configured Comparator implementation classes.</p> 27 * <h4>Thread Safety</h4> 28 * <p> 29 * Implementation dependent. {@link ComparatorManagerImpl} is a thread safe implementation. 30 * </p> 31 */ 32 public interface ComparatorManager { 33 34 /** 35 * <p>Gets a comparator by name.</p> 36 * 37 * @param name - 38 * The (logical) name of the Comparator 39 * @return a comparator, not null 40 * @throws LookupException 41 */ 42 public Comparator getComparator(String name) throws LookupException; 43 44 /** 45 * Is an explicit declaration in a <code>require</code> statement 46 * unnecessary for this comparator? 47 * @param comparatorName not null 48 * @return true when this comparator need not be declared by <core>require</code>, 49 * false when any usage of this comparator must be declared in a <code>require</code> statement 50 */ 51 public boolean isImplicitlyDeclared(final String comparatorName); 52 53 /** 54 * Is the comparator with the given name supported? 55 * @param name not null 56 * @return true when supported, false otherwise 57 */ 58 public boolean isSupported(String name); 59 }