/*
 * 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.
 */
package org.apache.openjpa.lib.meta;

import java.io.IOException;

/**
 * Filters metadata resources. Typically used to constrain the results
 * of a {@link MetaDataIterator}.
 *
 * @author Abe White
 */
public interface MetaDataFilter {

    /**
     * Return whether the given resource passes the filter.
     */
    boolean matches(Resource rsrc) throws IOException;

    /**
     * Information about a metadata resource.
     */
    public interface Resource {

        /**
         * The name of the resource.
         */
        String getName();

        /**
         * Resource content.
         */
        byte[] getContent() throws IOException;
    }
}
