com.thoughtworks.qdox.Searcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of qdox Show documentation

QDox is a high speed, small footprint parser for extracting class/interface/method definitions from source files complete with JavaDoc @tags. It is designed to be used by active code generators or documentation tools.

There is a newer version: 2.1.0

Show newest version

package com.thoughtworks.qdox;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import com.thoughtworks.qdox.model.JavaClass;

/**
 * A filter which evaluates the JavaClass and decides if it's part of the criteria. 
 * 
 *
 */
public interface Searcher
{

    /**
     * Evaluate the class
     * 
     * @param cls the class to evaluate
     * @return true if this class should be part of the criteria, otherwise false
     */
    boolean eval( JavaClass cls );

}