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
 Iterable<InhabitantParser> createScanner()
          Creates an InhabitantsScanner instance capable of returning the metadata for all inhabitant.
 String getSystemId()
          Return the unique identifier
 

Method Detail

getSystemId

String getSystemId()
Return the unique identifier

Returns:
unique id

createScanner

Iterable<InhabitantParser> createScanner()
                                         throws IOException
Creates an InhabitantsScanner instance capable of returning the metadata for all inhabitant.

Returns:
the scanner for inhabitant metadata
Throws:
IOException - if the scanner create fails initialization


Copyright © 2013 Oracle Corporation. All Rights Reserved.