001    /*
002     * Copyright (C) 2010 eXo Platform SAS.
003     *
004     * This is free software; you can redistribute it and/or modify it
005     * under the terms of the GNU Lesser General Public License as
006     * published by the Free Software Foundation; either version 2.1 of
007     * the License, or (at your option) any later version.
008     *
009     * This software is distributed in the hope that it will be useful,
010     * but WITHOUT ANY WARRANTY; without even the implied warranty of
011     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012     * Lesser General Public License for more details.
013     *
014     * You should have received a copy of the GNU Lesser General Public
015     * License along with this software; if not, write to the Free
016     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
017     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
018     */
019    
020    package org.crsh.cmdline.matcher;
021    
022    import org.crsh.cmdline.ClassDescriptor;
023    import org.crsh.cmdline.EmptyCompleter;
024    import org.crsh.cmdline.matcher.impl.MatcherImpl;
025    import org.crsh.cmdline.spi.Completer;
026    
027    import java.util.Map;
028    
029    /**
030     * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a>
031     * @version $Revision$
032     */
033    public abstract class Matcher<T> {
034    
035      public static <T> Matcher<T> createMatcher(String mainName, ClassDescriptor<T> descriptor) {
036        return new MatcherImpl<T>(mainName, descriptor);
037      }
038    
039      public static <T> Matcher<T> createMatcher(ClassDescriptor<T> descriptor) {
040        return new MatcherImpl<T>(descriptor);
041      }
042    
043      public final Map<String, String> complete(String s) throws CmdCompletionException {
044        return complete(EmptyCompleter.getInstance(), s);
045      }
046    
047      public abstract Map<String, String> complete(Completer completer, String s) throws CmdCompletionException;
048    
049    
050      public abstract CommandMatch<T, ?, ?> match(String s);
051    
052    }