org.jboss.shrinkwrap.descriptor.api

Interface Descriptor

public interface Descriptor

End-user domain-specific language (DSL) view of a metadata Descriptor.

Author:

Aslak Knutsen, ALR

Method Summary

Modifier and Type	Method and Description
String	exportAsString() Exports the descriptor as a String
void	exportTo(OutputStream output) Export the descriptor to a given OutputStream.
String	getDescriptorName() Get the Descriptor name.

Method Detail

getDescriptorName

String getDescriptorName()

Get the Descriptor name. The name can be specified by user at construction time, or predefined as a default by type.

Returns:

the descriptor name

exportAsString

String exportAsString()
               throws DescriptorExportException

Exports the descriptor as a String

Returns:

Throws:

DescriptorExportException

exportTo

void exportTo(OutputStream output)
       throws DescriptorExportException,
              IllegalArgumentException

Export the descriptor to a given OutputStream. The OutputStream will not be flushed or closed by this operation.

Parameters:

output - Where to export

Throws:

IllegalArgumentException - if output is null

DescriptorExportException - if problems exporting