org.apache.jsieve
Interface ComparatorManager

All Known Implementing Classes:
ComparatorManagerImpl

public interface ComparatorManager

Maps Comparator names to configured Comparator implementation classes.

Thread Safety

Implementation dependent. ComparatorManagerImpl is a thread safe implementation.


Method Summary
 Comparator getComparator(java.lang.String name)
          Gets a comparator by name.
 boolean isImplicitlyDeclared(java.lang.String comparatorName)
          Is an explicit declaration in a require statement unnecessary for this comparator?
 boolean isSupported(java.lang.String name)
          Is the comparator with the given name supported?
 

Method Detail

getComparator

Comparator getComparator(java.lang.String name)
                         throws LookupException

Gets a comparator by name.

Parameters:
name - - The (logical) name of the Comparator
Returns:
a comparator, not null
Throws:
LookupException

isImplicitlyDeclared

boolean isImplicitlyDeclared(java.lang.String comparatorName)
Is an explicit declaration in a require statement unnecessary for this comparator?

Parameters:
comparatorName - not null
Returns:
true when this comparator need not be declared by require, false when any usage of this comparator must be declared in a require statement

isSupported

boolean isSupported(java.lang.String name)
Is the comparator with the given name supported?

Parameters:
name - not null
Returns:
true when supported, false otherwise


Copyright © 2008-2009 The Apache Software Foundation. All Rights Reserved.