/*

  * Licensed 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.commons.classscan;

 import java.net.URL;

 import java.util.Iterator;

 /**

  * A single location in a ClassPath.  The location might be a jar or a directory.

  * In enterprise application environments, the location might be an exploded ear or a war.

  */

 public interface ClassPathElement extends Iterable<ClassFile> {

         /**

          * Get a Iterator over the files specified by this instance 

          */

         @Override

         Iterator<ClassFile> iterator();

         /**

          * Get the location of the class bytes.

          * This value is intended to be used as an argument to the {@link URL#URL(String) URL constructor}.

          */

         String getLocation();

         /**

          * Get a file with a particular name

          * 

          * @param fileName The name of the desired file (this may be a path such as META-INF/resources/com.example.group.interface)

          * @return null, if not found; otherwise the ResourceFile

          */

         ResourceFile getResource(String fileName);

 }