/*
 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.sun.tdk.jcov.filter;

import com.sun.tdk.jcov.instrument.DataClass;
import com.sun.tdk.jcov.instrument.DataField;
import com.sun.tdk.jcov.instrument.DataMethod;

/**
 * Interface for a class that sets acceptance criteria for classes and class
 * members.
 *
 * For both legacy and modern JCov data representation formats.
 *
 * @author Dmitry Fazunenko
 */
public interface MemberFilter {

    /**
     * The filter that accepts everything.
     */
    public static MemberFilter ACCEPT_ALL = new AcceptAll();

    /**
     * Returns true if a class is acceptable, false otherwise.
     */
    public boolean accept(DataClass clz);

    /**
     * Returns true if a method is acceptable, false otherwise.
     */
    public boolean accept(DataClass clz, DataMethod m);

    /**
     * Returns true if a field is acceptable, false otherwise.
     */
    public boolean accept(DataClass clz, DataField f);

    /**
     * Implementation accepting everthing
     */
    final static class AcceptAll implements MemberFilter {

        public boolean accept(DataClass clz) {
            return true;
        }

        public boolean accept(DataClass clz, DataMethod m) {
            return true;
        }

        public boolean accept(DataClass clz, DataField f) {
            return true;
        }

        @Override
        public String toString() {
            return "AcceptAll filter";
        }
    }
}
