org.apache.openjpa.lib.meta

Class ClassMetaDataIterator

java.lang.Object

org.apache.openjpa.lib.meta.ClassMetaDataIterator

All Implemented Interfaces:

MetaDataIterator, Closeable

public class ClassMetaDataIterator
extends java.lang.Object
implements MetaDataIterator

Iterator over all metadata resources that might contain the metadata for a given class, starting with the most general. Assumes that package-level resources are named "package.<suffix>".

Author:

Abe White

Constructor Summary

Constructors

Constructor and Description
ClassMetaDataIterator(java.lang.Class<?> cls, java.lang.String suffix, boolean topDown) Constructor; supply the class whose metadata to find, the suffix of metadata files, and whether to parse top-down or bottom-up.
ClassMetaDataIterator(java.lang.Class<?> cls, java.lang.String suffix, java.lang.ClassLoader loader, boolean topDown) Constructor; supply the class whose metadata to find, the suffix of metadata files, and whether to parse top-down or bottom-up.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the resources used by this iterator.
java.io.File	getFile() Return the last-iterated metadata resource content as a file, or null if not an extant file.
java.io.InputStream	getInputStream() Return the last-iterated metadata resource content as a stream.
boolean	hasNext() Return whether there is another resource to iterate over.
java.net.URL	next() Return the next metadata resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClassMetaDataIterator

public ClassMetaDataIterator(java.lang.Class<?> cls,
                     java.lang.String suffix,
                     boolean topDown)

Constructor; supply the class whose metadata to find, the suffix of metadata files, and whether to parse top-down or bottom-up.

ClassMetaDataIterator

public ClassMetaDataIterator(java.lang.Class<?> cls,
                     java.lang.String suffix,
                     java.lang.ClassLoader loader,
                     boolean topDown)

Constructor; supply the class whose metadata to find, the suffix of metadata files, and whether to parse top-down or bottom-up.

Method Detail

hasNext

public boolean hasNext()
                throws java.io.IOException

Description copied from interface: MetaDataIterator

Return whether there is another resource to iterate over.

Specified by:

hasNext in interface MetaDataIterator

Throws:

java.io.IOException

next

public java.net.URL next()
                  throws java.io.IOException

Description copied from interface: MetaDataIterator

Return the next metadata resource.

Specified by:

next in interface MetaDataIterator

Throws:

java.io.IOException

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Description copied from interface: MetaDataIterator

Return the last-iterated metadata resource content as a stream.

Specified by:

getInputStream in interface MetaDataIterator

Throws:

java.io.IOException

getFile

public java.io.File getFile()
                     throws java.io.IOException

Description copied from interface: MetaDataIterator

Return the last-iterated metadata resource content as a file, or null if not an extant file.

Specified by:

getFile in interface MetaDataIterator

Throws:

java.io.IOException

close

public void close()

Description copied from interface: MetaDataIterator

Close the resources used by this iterator.

Specified by:

close in interface MetaDataIterator

Specified by:

close in interface Closeable