com.sun.enterprise.module
Interface InhabitantsDescriptor

All Known Implementing Classes:

ByteArrayInhabitantsDescriptor

public interface InhabitantsDescriptor

Inhabitants Descriptor is an abstraction on how the inhabitants are represented in a module. It might be a file, or it might rely on some other mechanism like introspection to get the list of inhabitant.

Author:

Jerome Dochez

Method Summary

java.lang.Iterable<InhabitantParser>	createScanner() Creates an InhabitantsScanner instance capable of returning the metadata for all inhabitant.
java.lang.String	getSystemId() Return the unique identifier

Method Detail

getSystemId

java.lang.String getSystemId()

Return the unique identifier

Returns:

unique id

createScanner

java.lang.Iterable<InhabitantParser> createScanner()
                                                   throws java.io.IOException

Creates an InhabitantsScanner instance capable of returning the metadata for all inhabitant.

Returns:

the scanner for inhabitant metadata

Throws:

java.io.IOException - if the scanner create fails initialization