org.apache.openjpa.lib.meta
Class ClassMetaDataIterator

java.lang.Object
  extended by org.apache.openjpa.lib.meta.ClassMetaDataIterator
All Implemented Interfaces:
MetaDataIterator, Closeable

public class ClassMetaDataIterator
extends 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
ClassMetaDataIterator(Class cls, 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(Class cls, String suffix, 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
 void close()
          Close the resources used by this iterator.
 File getFile()
          Return the last-iterated metadata resource content as a file, or null if not an extant file.
 InputStream getInputStream()
          Return the last-iterated metadata resource content as a stream.
 boolean hasNext()
          Return whether there is another resource to iterate over.
 Object 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(Class cls,
                             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(Class cls,
                             String suffix,
                             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 IOException
Description copied from interface: MetaDataIterator
Return whether there is another resource to iterate over.

Specified by:
hasNext in interface MetaDataIterator
Throws:
IOException

next

public Object next()
            throws IOException
Description copied from interface: MetaDataIterator
Return the next metadata resource.

Specified by:
next in interface MetaDataIterator
Throws:
IOException

getInputStream

public InputStream getInputStream()
                           throws IOException
Description copied from interface: MetaDataIterator
Return the last-iterated metadata resource content as a stream.

Specified by:
getInputStream in interface MetaDataIterator
Throws:
IOException

getFile

public File getFile()
             throws 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:
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


Copyright © 2006-2008 Apache Software Foundation. All Rights Reserved.