63 lines
2.0 KiB
Java
63 lines
2.0 KiB
Java
/* ClassFileIterator.java
|
|
*
|
|
* Created: 2011-10-10 (Year-Month-Day)
|
|
* Character encoding: UTF-8
|
|
*
|
|
****************************************** LICENSE *******************************************
|
|
*
|
|
* Copyright (c) 2011 - 2013 XIAM Solutions B.V. (http://www.xiam.nl)
|
|
*
|
|
* 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.
|
|
*
|
|
* Modified 2014, dorkbox, llc
|
|
*/
|
|
package dorkbox.annotation;
|
|
|
|
import java.io.FilenameFilter;
|
|
import java.io.IOException;
|
|
import java.io.InputStream;
|
|
|
|
/**
|
|
* {@code ClassFileIterator} is used to iterate over all Java ClassFile files available within
|
|
* a specific context.
|
|
* <p/>
|
|
* For every Java ClassFile ({@code .class}) an {@link InputStream} is returned.
|
|
*
|
|
* @author <a href="mailto:rmuller@xiam.nl">Ronald K. Muller</a>
|
|
* @since annotation-detector 3.0.0
|
|
*/
|
|
public
|
|
interface ClassIterator {
|
|
|
|
/**
|
|
* Return the name of the Java ClassFile returned from the last call to {@link #next(FilenameFilter)}.
|
|
* The name is either the path name of a file or the name of an ZIP/JAR file entry.
|
|
*/
|
|
String getName();
|
|
|
|
/**
|
|
* Return {@code true} if the current {@link InputStream} is reading from a plain
|
|
* {@link File}.
|
|
* Return {@code false} if the current {@link InputStream} is reading from a
|
|
* ZIP File Entry.
|
|
*/
|
|
boolean isFile();
|
|
|
|
/**
|
|
* Return the next Java ClassFile as an {@code InputStream}.
|
|
* <p/>
|
|
* NOTICE: Client code MUST close the returned {@code InputStream}!
|
|
*/
|
|
InputStream next(final FilenameFilter filter) throws IOException;
|
|
}
|